Set the maintenance window for a cluster

curl --request PUT \ --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/maintenance-window \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --json '{"offset_duration":"172800s","window_duration":"21600s"}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id

string

required

Body

application/json

MaintenanceWindowSpec specifies a weekly recurring maintenance window for an ADVANCED cluster.

offset_duration

string

required

OffsetDuration is the duration from the start of a week (Monday 00:00 UTC) that this maintenance window will start after.

Must be less than 1 week.

window_duration

string

required

WindowDuration is the duration of the maintenance window.

Must be at least 6 hours and less than 1 week.

Response

A successful response.

MaintenanceWindowSpec specifies a weekly recurring maintenance window for an ADVANCED cluster.

offset_duration

string

required

OffsetDuration is the duration from the start of a week (Monday 00:00 UTC) that this maintenance window will start after.

Must be less than 1 week.

window_duration

string

required

WindowDuration is the duration of the maintenance window.

Must be at least 6 hours and less than 1 week.