Skip to main content
POST
/
v1
/
maintenance-windows
Create a maintenance window
curl --request POST \
  --url https://api.checklyhq.com/v1/maintenance-windows \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Maintenance Window",
  "tags": [
    "production"
  ],
  "startsAt": "2022-08-24",
  "endsAt": "2022-08-25",
  "repeatInterval": "null",
  "repeatUnit": "DAY",
  "repeatEndsAt": "null"
}'
{
  "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"
}

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

Body

application/json
​
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"

​
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

Response

Created

​
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

⌘I