GET
/
v1
/
maintenance-windows
/
{id}
Retrieve a maintenance window
curl --request GET \
  --url https://api.checklyhq.com/v1/maintenance-windows/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 1,
  "name": "Maintenance Window",
  "tags": [
    "production"
  ],
  "startsAt": "2022-08-24",
  "endsAt": "2022-08-25",
  "repeatInterval": "null",
  "repeatUnit": "DAY",
  "repeatEndsAt": "null",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

​
Overview

The Get Maintenance Window endpoint retrieves comprehensive details about a specific maintenance window, including its schedule, affected checks, and configuration settings. Common Use Cases:
  • Maintenance Window Configuration Review
  • Schedule Verification
  • Check Assignment Inspection
  • Window Management
This endpoint returns complete maintenance window configuration including scheduling details, affected checks, and notification settings.

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

Successful

​
id
number
required

The id of the maintenance window.

Example:

1

​
name
string
required

The maintenance window name.

Example:

"Maintenance Window"

​
startsAt
string<date>
required

The start date of the maintenance window.

Example:

"2022-08-24"

​
endsAt
string<date>
required

The end date of the maintenance window.

Example:

"2022-08-25"

​
repeatUnit
string
required

The repeat strategy for the maintenance window.

Example:

"DAY"

​
created_at
string<date>
required

The creation date of the maintenance window.

​
updated_at
string<date>
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

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

Required range: x >= 1
Example:

null

​
repeatEndsAt
string<date>

The end date where the maintenance window should stop repeating.

Example:

null