Checkly Maintenance Windows API
The Maintenance Windows API from Checkly — 12 operation(s) for maintenance windows.
Operations 12
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“What maintenance windows are scheduled in my Checkly account?”
“Can I filter maintenance windows by when they start or end?”
Tell an agent
List all my maintenance windows.
Show maintenance windows starting {startsAt}.
Ask an LLM
“How do I pause alerts during a planned deploy window?”
“Can a maintenance window repeat weekly and stop repeating on a set date?”
Tell an agent
Create a maintenance window {name} from {startsAt} to {endsAt} repeating {repeatUnit}.
Schedule maintenance {name} from {startsAt} to {endsAt}, repeat {repeatUnit}, for checks tagged {tags}.
Ask an LLM
“How do I remove a maintenance window I no longer need?”
“Is deleting a maintenance window permanent?”
Tell an agent destructive · confirm first
Delete maintenance window {id}.
Remove the whole maintenance window {id} from my account.
GET
/v1/maintenance-windows/{id}
Get a maintenance window's details · Retrieve a maintenance window
#
Ask an LLM
“Which checks does a specific maintenance window cover?”
“What schedule and timezone is a given maintenance window set to?”
Tell an agent
Show maintenance window {id}.
Get the settings of maintenance window {id}.
Ask an LLM
“Can I extend an existing maintenance window's end date?”
“How do I change which tags an existing maintenance window applies to?”
Tell an agent
Move maintenance window {id} to end at {endsAt}.
Rename maintenance window {id} to {name}.
GET
/v1/maintenance-windows/{id}/maintenances
List occurrences of a maintenance window · List maintenances for a maintenance window
#
Ask an LLM
“What individual maintenances has a recurring window produced?”
“Can I page through each scheduled occurrence of a maintenance window?”
Tell an agent
List the maintenance occurrences of window {id}.
Show page {page} of maintenances for window {id}.
DELETE
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Cancel one occurrence of a maintenance window · Delete a maintenance
#
Ask an LLM
“Can I skip just one occurrence of a recurring maintenance window?”
“How do I delete a single maintenance without removing the whole window?”
Tell an agent destructive · confirm first
Delete occurrence {maintenanceId} from maintenance window {id}.
Skip maintenance {maintenanceId} in window {id} but keep the rest.
GET
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Get one occurrence of a maintenance window · Retrieve a maintenance
#
Ask an LLM
“When does one specific occurrence of my recurring maintenance start?”
“Can I look up a single maintenance within a maintenance window?”
Tell an agent
Show maintenance {maintenanceId} of window {id}.
Get the dates of occurrence {maintenanceId} in maintenance window {id}.
PATCH
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}
Reschedule one maintenance occurrence · Update maintenance dates
#
Ask an LLM
“Can I shift the dates of a single maintenance occurrence?”
“How do I push back one scheduled maintenance by an hour?”
Tell an agent
Reschedule maintenance {maintenanceId} in window {id} to start {startsAt} and end {endsAt}.
Change the end of maintenance {maintenanceId} in window {id} to {endsAt}.
POST
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates
Post a status update for a maintenance · Create a maintenance window status update
#
Ask an LLM
“How do I tell status page subscribers that maintenance is in progress?”
“Can I post a maintenance progress update without emailing subscribers?”
Tell an agent
Post a {status} update on maintenance {maintenanceId} of window {id}: {description}.
Add update {description} with status {status} to maintenance {maintenanceId} in window {id} and notify subscribers {notifySubscribers}.
DELETE
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}
Delete a maintenance status update · Delete a maintenance window status update
#
Ask an LLM
“How do I take down a maintenance update posted by mistake?”
“Can I delete one status update from a maintenance?”
Tell an agent destructive · confirm first
Delete update {updateId} from maintenance {maintenanceId} in window {id}.
Remove status update {updateId} on maintenance {maintenanceId} of window {id}.
PUT
/v1/maintenance-windows/{id}/maintenances/{maintenanceId}/updates/{updateId}
Edit a maintenance status update · Update a maintenance window status update
#
Ask an LLM
“Can I fix a typo in a maintenance update I already posted?”
“Does editing a maintenance update keep its status if I leave status out?”
Tell an agent
Change the text of update {updateId} on maintenance {maintenanceId} in window {id} to {description}.
Set update {updateId} on maintenance {maintenanceId} of window {id} to status {status} with text {description}.