Retrieve a maintenance window

Show details of a specific maintenance window.

GET /v1/maintenance-windows/{id}

Retrieve a maintenance window

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/maintenance-windows/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": 1,
  "name": "<string>",
  "startsAt": "2023-12-25",
  "endsAt": "2023-12-25",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "tags": [
    "production"
  ],
  "repeatInterval": 123,
  "repeatEndsAt": "2023-12-25",
  "description": "<string>",
  "statusPageVisibility": {
    "enabled": true,
    "affectAllServices": true,
    "suppressAutoIncidents": true,
    "notifyOnStart": true,
    "notifyOnEnd": true,
    "reminderMinutesBefore": [
      123
    ],
    "autoStart": true,
    "autoEnd": true,
    "statusPageIds": [
      "<string>"
    ],
    "serviceIds": [
      "<string>"
    ]
  },
  "pauseAllChecks": true,
  "silenceAlertsTags": [
    "<string>"
  ],
  "silenceAllAlerts": true
}

Authorizations

Authorization · string · header · required

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

x-checkly-account · string

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

Path Parameters

id · integer · required

Response

200

application/json

Successful

id · number · required

The id of the maintenance window.

Example:

1

name · string · required

startsAt · string<date> · required

endsAt · string<date> · required

created_at · string<date> · required

The creation date of the maintenance window.

updated_at · string<date> | null · required

The last date that the maintenance window was updated.

tags · string[]

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

Example:

["production"]

repeatInterval · number | null

repeatUnit · enum<string> | null

Available options: DAY, WEEK, MONTH

repeatEndsAt · string<date> | null

description · string | null

statusPageVisibility · object

Show child attributes

pauseAllChecks · boolean

silenceAlertsTags · string[]

silenceAllAlerts · boolean