Checkly Maintenance Windows API
The Maintenance Windows API from Checkly — 12 operation(s) for maintenance windows.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/checkly-maintenance-windows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Checkly Public Maintenance windows API
version: v1
description: These are the docs for the newly released Checkly Public API.<br />If you have any questions, please do not hesitate to get in touch with us.
servers:
- url: https://api.checklyhq.com
security:
- Bearer: []
tags:
- name: Maintenance windows
paths:
/v1/maintenance-windows:
get:
summary: List all maintenance windows
operationId: getV1Maintenancewindows
description: Lists all maintenance windows in your account.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: limit
in: query
schema:
type: integer
description: Limit the number of results
default: 10
minimum: 1
maximum: 100
description: Limit the number of results
- name: page
in: query
schema:
type: number
description: Page number
default: 1
x-constraint:
sign: positive
description: Page number
- name: startsAt
in: query
schema:
description: Filter for items which startsAt field matches the constraint
anyOf:
- type: object
properties:
gt:
type: string
format: date
required:
- gt
- type: object
properties:
gte:
type: string
format: date
required:
- gte
- type: object
properties:
lt:
type: string
format: date
required:
- lt
- type: object
properties:
lte:
type: string
format: date
required:
- lte
description: Filter for items which startsAt field matches the constraint
- name: endsAt
in: query
schema:
description: Filter for items which endsAt field matches the constraint
anyOf:
- type: object
properties:
gt:
type: string
format: date
required:
- gt
- type: object
properties:
gte:
type: string
format: date
required:
- gte
- type: object
properties:
lt:
type: string
format: date
required:
- lt
- type: object
properties:
lte:
type: string
format: date
required:
- lte
description: Filter for items which endsAt field matches the constraint
tags:
- Maintenance windows
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowList'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
post:
summary: Create a maintenance window
operationId: postV1Maintenancewindows
description: 'Creates a new maintenance window. Status-page-only fields live under `statusPageVisibility` and only take effect when `statusPageVisibility.enabled: true`.'
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
tags:
- Maintenance windows
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowCreate'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindow'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
/v1/maintenance-windows/{id}:
delete:
summary: Delete a maintenance window
operationId: deleteV1MaintenancewindowsId
description: Permanently removes a maintenance window.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
tags:
- Maintenance windows
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
get:
summary: Retrieve a maintenance window
operationId: getV1MaintenancewindowsId
description: Show details of a specific maintenance window.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
tags:
- Maintenance windows
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindow'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
put:
summary: Update a maintenance window
operationId: putV1MaintenancewindowsId
description: 'Partially updates a maintenance window. Only fields included in the request body are modified; omitted fields are left unchanged. Status-page-only fields live under `statusPageVisibility` and only take effect when `statusPageVisibility.enabled: true`.'
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
tags:
- Maintenance windows
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowUpdate'
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindow'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
/v1/maintenance-windows/{id}/maintenances:
get:
summary: List maintenances for a maintenance window
operationId: getV1MaintenancewindowsIdMaintenances
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: page
in: query
schema:
type: integer
default: 1
minimum: 1
- name: limit
in: query
schema:
type: integer
default: 10
minimum: 1
maximum: 50
tags:
- Maintenance windows
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowMaintenanceList'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}:
delete:
summary: Delete a maintenance
operationId: deleteV1MaintenancewindowsIdMaintenancesMaintenanceid
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
get:
summary: Retrieve a maintenance
operationId: getV1MaintenancewindowsIdMaintenancesMaintenanceid
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowMaintenance'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
patch:
summary: Update maintenance dates
operationId: patchV1MaintenancewindowsIdMaintenancesMaintenanceid
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Model63'
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowMaintenance'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates:
post:
summary: Create a maintenance window status update
operationId: postV1MaintenancewindowsIdMaintenancesMaintenanceidUpdates
description: Creates a new status update for a status-page-visible maintenance window.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowUpdatePayload'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/Model62'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}:
delete:
summary: Delete a maintenance window status update
operationId: deleteV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid
description: Permanently removes a status update from a maintenance window.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
- name: updateId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
put:
summary: Update a maintenance window status update
operationId: putV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid
description: Updates a status update for a status-page-visible maintenance window.
parameters:
- name: x-checkly-account
in: header
schema:
type: string
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
- name: id
in: path
schema:
type: integer
x-constraint:
sign: positive
required: true
- name: maintenanceId
in: path
schema:
type: string
x-format:
guid: true
required: true
- name: updateId
in: path
schema:
type: string
x-format:
guid: true
required: true
tags:
- Maintenance windows
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MaintenanceWindowUpdateEditPublicPayload'
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/Model62'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedError'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenError'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
components:
schemas:
attributes:
type: object
MaintenanceWindowTagList:
type: array
description: The names of the checks and groups maintenance window should apply to.
example:
- production
items:
type: string
repeatUnit:
type:
- string
- 'null'
enum:
- DAY
- WEEK
- MONTH
updates:
type: array
items:
$ref: '#/components/schemas/Model62'
ProjectBindingReferencesV1:
type: array
description: Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
items:
$ref: '#/components/schemas/ProjectBindingV1'
silenceAlertsTags:
type: array
items:
type: string
MaintenanceWindowMaintenanceList:
type: array
items:
$ref: '#/components/schemas/MaintenanceWindowMaintenance'
Model58:
type: array
description: 'Minutes before maintenance to send reminder notifications. Only takes effect when `enabled: true`.'
maxItems: 3
items:
type: integer
minimum: 60
maximum: 10080
Model54:
type: array
description: 'Status page IDs to link this maintenance window to. Requires `serviceIds` or `affectAllServices: true`. On PUT, send `[]` together with `serviceIds: []` to fully unlink. Only takes effect when `enabled: true`.'
items:
type: string
x-format:
guid: true
dateAdjustments:
type:
- object
- 'null'
properties:
startsAt:
type: string
format: date
endsAt:
type: string
format: date
Model2:
type: string
enum:
- Too Many Requests
Model57:
type:
- string
- 'null'
description: 'The severity level displayed on the status page. Only takes effect when `enabled: true`.'
enum:
- MINOR
- MEDIUM
- MAJOR
- CRITICAL
MaintenanceWindowStatusPageVisibility:
type: object
description: Status page visibility and subscriber-facing maintenance settings.
default: {}
properties:
enabled:
type: boolean
description: Whether this maintenance window appears on linked status pages. This is the master gate for every other status-page visibility field.
default: false
severity:
$ref: '#/components/schemas/Model52'
affectAllServices:
type: boolean
description: 'Whether all services on the linked status pages are affected. Mutually exclusive with a non-empty `serviceIds` array. Only takes effect when `enabled: true`.'
default: false
notifyOnStart:
type: boolean
description: 'Whether to email subscribers when maintenance starts. Only takes effect when `enabled: true`.'
default: false
notifyOnEnd:
type: boolean
description: 'Whether to email subscribers when maintenance ends. Only takes effect when `enabled: true`.'
default: false
suppressAutoIncidents:
type: boolean
description: 'Whether to suppress auto-created incidents for linked services during maintenance. Only takes effect when `enabled: true`.'
default: false
reminderMinutesBefore:
$ref: '#/components/schemas/Model53'
autoStart:
type: boolean
description: 'Automatically start the maintenance at the scheduled time. Only honored when `enabled: true`; on hidden windows the system always auto-starts regardless of this value.'
default: true
autoEnd:
type: boolean
description: 'Automatically complete the maintenance at the scheduled end time. Only honored when `enabled: true`; on hidden windows the system always auto-ends regardless of this value.'
default: true
showAffectedServices:
type: boolean
description: 'Whether the public status page shows which services this maintenance window affects. When false, the window is still shown as a general event but without its affected services, and its maintenance period is not excluded from service uptime: downtime during the window counts as regular downtime. Only takes effect when `enabled: true`.'
default: true
statusPageIds:
$ref: '#/components/schemas/Model54'
serviceIds:
$ref: '#/components/schemas/Model55'
UnauthorizedError:
type: object
properties:
statusCode:
type: number
enum:
- 401
error:
$ref: '#/components/schemas/error'
message:
type: string
example: Bad Token
attributes:
$ref: '#/components/schemas/attributes'
required:
- statusCode
- error
TooManyRequestsError:
type: object
properties:
statusCode:
type: number
enum:
- 429
error:
$ref: '#/components/schemas/Model2'
message:
type: string
example: Too Many Requests
attributes:
$ref: '#/components/schemas/attributes'
required:
- statusCode
- error
Model50:
type:
- string
- 'null'
enum:
- MINOR
- MEDIUM
- MAJOR
- CRITICAL
Model64:
type: string
description: The lifecycle status of this update.
enum:
- SCHEDULED
- IN_PROGRESS
- VERIFYING
- COMPLETED
- CANCELLED
MaintenanceWindowUpdatePayload:
type: object
properties:
status:
$ref: '#/components/schemas/Model64'
description:
type: string
description: A description of the update.
maxLength: 2000
notifySubscribers:
type: boolean
description: Whether to notify status page subscribers about this update.
default: false
required:
- status
- description
serviceIds:
type: array
items:
type: string
x-format:
guid: true
Model60:
type: array
description: 'Status page service IDs affected by this maintenance window. Each service must belong to one of the linked status pages. Only takes effect when `enabled: true`.'
items:
type: string
x-format:
guid: true
MaintenanceWindowCreate:
type: object
properties:
name:
type: string
description: The maintenance window name.
example: Maintenance Window
maxLength: 200
tags:
$ref: '#/components/schemas/MaintenanceWindowTagList'
startsAt:
type: string
format: date
description: The start date of the maintenance window.
example: '2022-08-24'
endsAt:
type: string
format: date
description: The end date of the maintenance window.
example: '2022-08-25'
repeatInterval:
type:
- integer
- 'null'
description: The repeat interval of the maintenance window from the first occurrence.
example: null
default: null
minimum: 1
maximum: 365
repeatUnit:
type: string
description: The repeat strategy for the maintenance window.
example: DAY
repeatEndsAt:
type:
- string
- 'null'
format: date
description: An inclusive calendar date in the configured timezone (UTC when unset) on which occurrences may start. Prefer YYYY-MM-DD. For backward compatibility, other accepted date-time values are normalized to the UTC calendar date of the parsed instant. The final occurrence runs for its full configured duration.
example: null
timezone:
type:
- string
- 'null'
description: Named IANA time zone used for recurring maintenance scheduling. UTC offset identifiers such as "+05:00" are not accepted. On create, omission or null uses UTC. On update, omission preserves the exi
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/checkly/refs/heads/main/openapi/checkly-maintenance-windows-api-openapi.yml