Sign in
Maintenance windows

Retrieve a maintenance window

Show details of a specific maintenance window.

get/v1/maintenance-windows/{id}

Path parameters

idinteger required

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

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 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"
  ],
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check"
        }
      }
    ]
  }
}

Changes

Changed in 2 of the 4 revisions of this API.3

  • 87d29dc7b4fe1See the full diff
    • ○

      added the optional property projectBindings to the response with the 200 status

      response-optional-property-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9e903da4f3da2See the full diff
    • ○

      added the optional property statusPageVisibility/showAffectedServices to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property timezone to the response with the 200 status

      response-optional-property-added