CHchecklyhq
Maintenance windows

Update a maintenance window

Changed on

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}

Request

Path parameters

idinteger required

Headers

x-checkly-accountstring

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

Request body

namestring

The maintenance window name.

tagsstring[]

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

startsAtstring date

The start date of the maintenance window.

endsAtstring date

The end date of the maintenance window.

repeatIntervalinteger nullable

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

repeatEndsAtstring date nullable

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.

timezonestring nullable

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.

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.

repeatUnit'DAY' | 'WEEK' | 'MONTH' nullable

Example request

{
  "name": "Maintenance Window",
  "tags": [
    "production"
  ],
  "startsAt": "2022-08-24",
  "endsAt": "2022-08-25",
  "timezone": "America/New_York"
}

Response

Successful

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
timezonestring required

Named IANA time zone used for recurring maintenance scheduling; UTC when no timezone is set.

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"
  ],
  "timezone": "America/New_York",
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check",
        "sourceFile": "src/__checks__/homepage.check.ts"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      }
    ]
  }
}

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

  • aba5d34c749bRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status