CHchecklyhq
Maintenance windows

Retrieve a maintenance window

Changed on

Show details of a specific maintenance window.

get/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

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