Checkly Status Pages V3 Incidents API
The Status Pages V3 Incidents API from Checkly — 11 operation(s) for status pages v3 incidents.
Operations 11
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
GET
/v3/status-pages/{statusPageId}/incidents
List incidents on a status page · List the incidents of a v3 status page
#
Ask an LLM
“Which incidents are on my status page, most recently updated first?”
“Can I page through a status page's incident history?”
Tell an agent
List incidents on status page {statusPageId}.
Show the next {limit} incidents on status page {statusPageId} after {nextId}.
POST
/v3/status-pages/{statusPageId}/incidents
Open an incident on a status page · Open an incident on a v3 status page
#
Ask an LLM
“How do I declare an outage on my status page?”
“Can a new incident mark specific components as impacted right away?”
Tell an agent
Open incident {name} on status page {statusPageId} with first update {incidentUpdates}.
Declare incident {name} on status page {statusPageId} impacting {componentImpacts}, starting with {incidentUpdates}.
DELETE
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Delete an incident from a status page · Delete an incident of a v3 status page
#
Ask an LLM
“How do I remove an incident posted by mistake from my status page?”
“Does deleting an incident also delete all of its updates?”
Tell an agent destructive · confirm first
Delete incident {incidentId} from status page {statusPageId}.
Permanently remove incident {incidentId} and its updates from page {statusPageId}.
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Get an incident on a status page · Retrieve an incident of a v3 status page
#
Ask an LLM
“What updates and component impacts does a specific incident have?”
“Can I see the full detail of one incident on my status page?”
Tell an agent
Show incident {incidentId} on status page {statusPageId}.
Get the details and impacts of incident {incidentId} from status page {statusPageId}.
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Rename an incident or set component status · Update an incident of a v3 status page
#
Ask an LLM
“Can I rename an incident that's already open on my status page?”
“How can I change which components an open incident currently affects?”
Tell an agent
Rename incident {incidentId} on status page {statusPageId} to {name}.
Set incident {incidentId} on page {statusPageId} to name {name} with current impacts {componentImpacts}.
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}/component-impacts
Rewrite an incident's component impact timeline · Replace an incident's component impact timeline
#
Ask an LLM
“Can I retroactively correct when each component was impacted during an incident?”
“Is there a way to replace an incident's whole per-component impact history?”
Tell an agent
Replace the impact timeline of incident {incidentId} on page {statusPageId} with {componentImpacts}.
Retroactively set the component windows for incident {incidentId} on status page {statusPageId} to {componentImpacts}.
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
List the updates posted to an incident · List the updates of an incident
#
Ask an LLM
“What progress updates have been posted on an incident so far?”
“How many updates does the incident update list return at most?”
Tell an agent
List updates for incident {incidentId} on status page {statusPageId}.
Show the newest-first update history of incident {incidentId} on page {statusPageId}.
POST
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
Post a progress update to an incident · Post an update to an incident
#
Ask an LLM
“How do I post a status update to an ongoing incident?”
“Does posting a RESOLVED update close the incident?”
Tell an agent
Post update {description} with status {status} to incident {incidentId} on page {statusPageId}.
Resolve incident {incidentId} on status page {statusPageId} with the note {description} and status {status}.
DELETE
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Delete an incident update · Delete an incident update
#
Ask an LLM
“Can I delete one update from an incident's history?”
“Why can't I delete the last remaining update on an incident?”
Tell an agent destructive · confirm first
Delete update {incidentUpdateId} from incident {incidentId} on status page {statusPageId}.
Remove the incident update {incidentUpdateId} posted on incident {incidentId}, page {statusPageId}.
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Get a single incident update · Retrieve an incident update
#
Ask an LLM
“What did one specific incident update say?”
“Can I read back a single update I posted to an incident?”
Tell an agent
Show update {incidentUpdateId} of incident {incidentId} on status page {statusPageId}.
Get incident update {incidentUpdateId} from incident {incidentId} on page {statusPageId}.
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Edit an incident update already posted · Edit an incident update
#
Ask an LLM
“Can I fix a typo in an update I already posted to an incident?”
“Is it possible to change the status or public date on an existing incident update?”
Tell an agent
Edit update {incidentUpdateId} on incident {incidentId} (page {statusPageId}) to say {description} with status {status}.
Correct the text of incident update {incidentUpdateId} for incident {incidentId} on {statusPageId} to {description}, keeping status {status}.