Update a maintenance window

Partially updates a maintenance window. Only fields included in the request body are modified; omitted fields are left unchanged. Status-page-only fields live under statusPageVisibility and only take effect when statusPageVisibility.enabled: true.

PUT /v1/maintenance-windows/{id}

Update a maintenance window

cURL

curl --request PUT \
  --url https://api.checklyhq.com/v1/maintenance-windows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Maintenance Window",
  "tags": [
    "production"
  ],
  "startsAt": "2022-08-24",
  "endsAt": "2022-08-25",
  "repeatInterval": null,
  "repeatEndsAt": null,
  "pauseAllChecks": false,
  "silenceAlertsTags": [
    "<string>"
  ],
  "silenceAllAlerts": false,
  "description": null,
  "statusPageVisibility": {}
}
'

200

{
  "id": 1,
  "name": "<string>",
  "startsAt": "2023-12-25",
  "endsAt": "2023-12-25",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "tags": [
    "production"
  ],
  "repeatInterval": 123,
  "repeatEndsAt": "2023-12-25",
  "description": "<string>",
  "statusPageVisibility": {
    "enabled": true,
    "affectAllServices": true,
    "suppressAutoIncidents": true,
    "notifyOnStart": true,
    "notifyOnEnd": true,
    "reminderMinutesBefore": [
      123
    ],
    "autoStart": true,
    "autoEnd": true,
    "statusPageIds": [
      "<string>"
    ],
    "serviceIds": [
      "<string>"
    ]
  },
  "pauseAllChecks": true,
  "silenceAlertsTags": [
    "<string>"
  ],
  "silenceAllAlerts": true
}

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Path Parameters

id · integer · required

Body

application/json

name · string

The maintenance window name.

Maximum string length: 200

Example:

"Maintenance Window"

tags · string[]

The names of the checks and groups maintenance window should apply to.

Example:

["production"]

startsAt · string<date>

The start date of the maintenance window.

Example:

"2022-08-24"

endsAt · string<date>

The end date of the maintenance window.

Example:

"2022-08-25"

repeatInterval · number | null

The repeat interval of the maintenance window from the first occurance.

Required range: x >= 1

Example:

null

repeatEndsAt · string<date> | null

The end date where the maintenance window should stop repeating.

Example:

null

pauseAllChecks · boolean · default: false

Whether to pause all checks in the account (overrides tag scope).

silenceAlertsTags · string[]

Tags defining which checks have alerts silenced (when silenceAllAlerts is false).

silenceAllAlerts · boolean · default: false

Whether to silence alerts for all checks (overrides silenceAlertsTags scope).

description · string | null

A description of the maintenance window. When the window is visible on status pages, this description is shown there too.

Maximum string length: 2000

statusPageVisibility · object

Status page visibility and subscriber-facing maintenance settings.

Show child attributes

repeatUnit · enum<string> | null

Available options: DAY, WEEK, MONTH

Response

200

application/json

Successful

id · number · required

The id of the maintenance window.

Example:

1

name · string · required

startsAt · string<date> · required

endsAt · string<date> · required

created_at · string<date> · required

The creation date of the maintenance window.

updated_at · string<date> | null · required

The last date that the maintenance window was updated.

tags · string[]

The names of the checks and groups maintenance window should apply to.

Example:

["production"]

repeatInterval · number | null

repeatUnit · enum<string> | null

Available options: DAY, WEEK, MONTH

repeatEndsAt · string<date> | null

description · string | null

statusPageVisibility · object

Show child attributes

pauseAllChecks · boolean

silenceAlertsTags · string[]

silenceAllAlerts · boolean