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.
Authorizations
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
Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
Path Parameters
Body
The maintenance window name.
200"Maintenance Window"
The names of the checks and groups maintenance window should apply to.
The start date of the maintenance window.
"2022-08-24"
The end date of the maintenance window.
"2022-08-25"
The repeat interval of the maintenance window from the first occurrence.
1 <= x <= 365null
An inclusive calendar date in the configured timezone (UTC when unset) on which occurrences may start. Prefer YYYY-MM-DD. For backward compatibility, other accepted date-time values are normalized to the UTC calendar date of the parsed instant. The final occurrence runs for its full configured duration.
null
Named IANA time zone used for recurring maintenance scheduling. UTC offset identifiers such as "+05:00" are not accepted. On create, omission or null uses UTC. On update, omission preserves the existing value; null or UTC resets scheduling to UTC. Changing only this field keeps startsAt and endsAt as the same absolute instants; include recalculated anchors to preserve the existing local date and time.
"America/New_York"
Whether to pause all checks in the account (overrides tag scope).
Tags defining which checks have alerts silenced (when silenceAllAlerts is false).
Whether to silence alerts for all checks (overrides silenceAlertsTags scope).
A description of the maintenance window. When the window is visible on status pages, this description is shown there too.
2000Status page visibility and subscriber-facing maintenance settings.
DAY, WEEK, MONTH Response
Successful
The id of the maintenance window.
1
The creation date of the maintenance window.
The last date that the maintenance window was updated.
The names of the checks and groups maintenance window should apply to.
DAY, WEEK, MONTH