How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkly Maintenance Windows API

The Maintenance Windows API from Checkly — 12 operation(s) for maintenance windows.

Checkly Maintenance Windows API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Maintenance Windows. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 6 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

12 operations 6 paths 49 schemas 3 DELETE4 GET1 PATCH2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Maintenance Windows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — 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 t…

Paths & Operations 12

Across 6 paths, the API surfaces 12 operations — 3 DELETE, 4 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Maintenance windows 12
GET
/v1/maintenance-windows
List all maintenance windows
getV1Maintenancewindows 5 params → 200401403429
POST
/v1/maintenance-windows
Create a maintenance window
postV1Maintenancewindows 1 param body → 201401403429
DELETE
/v1/maintenance-windows/{id}
Delete a maintenance window
deleteV1MaintenancewindowsId 2 params → 204401403404429
GET
/v1/maintenance-windows/{id}
Retrieve a maintenance window
getV1MaintenancewindowsId 2 params → 200401403404429
PUT
/v1/maintenance-windows/{id}
Update a maintenance window
putV1MaintenancewindowsId 2 params body → 200401403404429
GET
/v1/maintenance-windows/{id}/maintenances
List maintenances for a maintenance window
getV1MaintenancewindowsIdMaintenances 4 params → 200401403404429
DELETE
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Delete a maintenance
deleteV1MaintenancewindowsIdMaintenancesMaintenanceid 3 params → 204401403404429
GET
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Retrieve a maintenance
getV1MaintenancewindowsIdMaintenancesMaintenanceid 3 params → 200401403404429
PATCH
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Update maintenance dates
patchV1MaintenancewindowsIdMaintenancesMaintenanceid 3 params body → 200401403404429
POST
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates
Create a maintenance window status update
postV1MaintenancewindowsIdMaintenancesMaintenanceidUpdates 3 params body → 201401403404429
DELETE
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}
Delete a maintenance window status update
deleteV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid 4 params → 204401403404429
PUT
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}
Update a maintenance window status update
putV1MaintenancewindowsIdMaintenancesMaintenanceidUpdatesUpdateid 4 params body → 200401403404429

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are MaintenanceWindow (17 properties), MaintenanceWindowUpdate (13 properties), MaintenanceWindowCreate (13 properties), MaintenanceWindowStatusPageVisibilityResponse (12 properties). Each schema is shown below with its type and property counts.

attributes
object
MaintenanceWindowTagList
array
The names of the checks and groups maintenance window should apply to.
repeatUnit
stringnull
updates
array
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
silenceAlertsTags
array
MaintenanceWindowMaintenanceList
array
Model58
array
Minutes before maintenance to send reminder notifications. Only takes effect when enabled: true.
Model54
array
Status page IDs to link this maintenance window to. Requires serviceIds or affectAllServices: true. On PUT, send [] together with serviceIds: [] to fully unlin…
dateAdjustments
objectnull
2 properties
Model2
string
Model57
stringnull
The severity level displayed on the status page. Only takes effect when enabled: true.
MaintenanceWindowStatusPageVisibility
object
Status page visibility and subscriber-facing maintenance settings.
12 properties
UnauthorizedError
object
4 properties 2 required
TooManyRequestsError
object
4 properties 2 required
Model50
stringnull
Model64
string
The lifecycle status of this update.
MaintenanceWindowUpdatePayload
object
3 properties 2 required
serviceIds
array
Model60
array
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.
MaintenanceWindowCreate
object
13 properties 4 required
Model56
array
Tags defining which checks have alerts silenced (when silenceAllAlerts is false).
Model52
stringnull
The severity level displayed on the status page. Only takes effect when enabled: true.
MaintenanceWindowList
array
Model62
object
11 properties 7 required
MaintenanceWindowMaintenance
object
8 properties 7 required
Model51
array
Tags defining which checks have alerts silenced (when silenceAllAlerts is false).
statusPageIds
array
MaintenanceWindow
object
17 properties 6 required
Model65
string
The lifecycle status of this update. Optional. When omitted, the stored status is preserved.
ProjectBindingV1
object
2 properties 2 required
MaintenanceWindowUpdate
object
13 properties
ForbiddenError
object
3 properties 2 required
MaintenanceWindowUpdateEditPublicPayload
object
2 properties 1 required
Model63
object
2 properties
Model61
object
Status page visibility and subscriber-facing maintenance settings.
12 properties
ProjectBindingDetailsV1
object
The resource's side of this binding.
2 properties 2 required
ProjectBindingOwnerV1
objectnull
The project that owns this resource — the one whose deploy can delete it. Null when no project owns it, including when other projects merely reference it. In t…
2 properties 2 required
BindingProjectV1
object
The project this binding is to.
3 properties 3 required
Model55
array
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.
NotFoundError
object
3 properties 2 required
error
string
reminderMinutesBefore
array
Model4
string
Model53
array
Minutes before maintenance to send reminder notifications. Only takes effect when enabled: true.
Model1
string
ProjectBindingsV1
object
The Checkly CLI projects that manage this resource. owner is null and references empty when the resource is not managed by code.
2 properties 2 required
Model59
array
Status page IDs to link this maintenance window to. Requires serviceIds or affectAllServices: true. On PUT, send [] together with serviceIds: [] to fully unlin…
MaintenanceWindowStatusPageVisibilityResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-maintenance-windows-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Accounts API
Checkly Alert Channels API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Checks API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Private Locations API
Where this information came from

This is an independent, third-party profile of Checkly Maintenance Windows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.