Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Maintenance windows

Create a maintenance window

Creates a new maintenance window. Status-page-only fields live under statusPageVisibility and only take effect when statusPageVisibility.enabled: true.

post/v1/maintenance-windows

Headers

x-checkly-accountstring

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

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

Request body

namestring required

The maintenance window name.

tagsstring[]

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

startsAtstring date required

The start date of the maintenance window.

endsAtstring date required

The end date of the maintenance window.

repeatIntervalnumber nullable

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

repeatUnitstring required

The repeat strategy for the maintenance window.

repeatEndsAtstring date nullable

The end date where the maintenance window should stop repeating.

pauseAllChecksboolean

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

silenceAlertsTagsstring[]

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

silenceAllAlertsboolean

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

descriptionstring nullable

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

Example request

{
  "name": "Maintenance Window",
  "tags": [
    "production"
  ],
  "startsAt": "2022-08-24",
  "endsAt": "2022-08-25",
  "repeatUnit": "DAY"
}

Response

Created

idnumber required

The id of the maintenance window.

namestring required
tagsstring[]

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

startsAtstring date required
endsAtstring date required
repeatIntervalnumber nullable
repeatUnit'DAY' | 'WEEK' | 'MONTH' nullable
repeatEndsAtstring date nullable
descriptionstring nullable
pauseAllChecksboolean
silenceAlertsTagsstring[]
silenceAllAlertsboolean
created_atstring date required

The creation date of the maintenance window.

updated_atstring date nullable required

The last date that the maintenance window was updated.

Example response

{
  "id": 1,
  "tags": [
    "production"
  ]
}