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 Status Pages V3 Incidents API

The Status Pages V3 Incidents API from Checkly — 11 operation(s) for status pages v3 incidents.

Checkly Status Pages V3 Incidents API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Status Pages V3 Incidents. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v1.

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

11 operations 5 paths 31 schemas 2 DELETE4 GET2 POST3 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 Status Pages V3 Incidents 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 11

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

Status Pages V3 Incidents 11
GET
/v3/status-pages/{statusPageId}/incidents
List the incidents of a v3 status page.
listStatusPageV3IncidentsPublic 4 params → 200401403404429
POST
/v3/status-pages/{statusPageId}/incidents
Open an incident on a v3 status page.
createStatusPageV3IncidentPublic 2 params body → 201401403404429
DELETE
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Delete an incident of a v3 status page.
deleteStatusPageV3IncidentPublic 3 params → 204401403404429
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Retrieve an incident of a v3 status page.
getStatusPageV3IncidentPublic 3 params → 200401403404429
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}
Update an incident of a v3 status page.
updateStatusPageV3IncidentPublic 3 params body → 200401403404429
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}/component-impacts
Replace an incident's component impact timeline.
replaceStatusPageV3IncidentComponentImpactsPublic 3 params body → 200401403404429
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
List the updates of an incident.
listStatusPageV3IncidentUpdatesPublic 3 params → 200401403404429
POST
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates
Post an update to an incident.
createStatusPageV3IncidentUpdatePublic 3 params body → 201401403404429
DELETE
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Delete an incident update.
deleteStatusPageV3IncidentUpdatePublic 4 params → 204401403404429
GET
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Retrieve an incident update.
getStatusPageV3IncidentUpdatePublic 4 params → 200401403404429
PUT
/v3/status-pages/{statusPageId}/incidents/{incidentId}/incident-updates/{incidentUpdateId}
Edit an incident update.
updateStatusPageV3IncidentUpdatePublic 4 params body → 200401403404429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are PublicStatusPageV3Incident (9 properties), PublicStatusPageV3IncidentListItem (8 properties), PublicStatusPageV3IncidentUpdate (6 properties), PublicStatusPageV3IncidentUpdateMutation (4 properties). Each schema is shown below with its type and property counts.

attributes
object
PublicStatusPageV3IncidentUpdate
object
6 properties 4 required
PublicStatusPageV3Incident
object
9 properties 6 required
Model2
string
UnauthorizedError
object
4 properties 2 required
TooManyRequestsError
object
4 properties 2 required
PublicStatusPageV3ComponentImpact
object
2 properties 2 required
PublicStatusPageV3IncidentListItem
object
8 properties 5 required
Model93
string
PublicStatusPageV3ReplaceComponentImpacts
object
1 property 1 required
PublicStatusPageV3ComponentImpactWindow
object
4 properties 4 required
PublicStatusPageV3ComponentImpactWindows
array
PublicStatusPageV3IncidentsEntries
array
PublicStatusPageV3IncidentCreate
object
3 properties 2 required
PublicStatusPageV3IncidentMutation
object
2 properties 1 required
PublicStatusPageV3IncidentUpdatesResponse
array
ForbiddenError
object
3 properties 2 required
PublicStatusPageV3ComponentImpacts
array
The current status of each impacted component. Omitted components are OPERATIONAL.
PublicStatusPageV3ComponentImpactResponse
object
4 properties 3 required
PublicStatusPageV3IncidentUpdateMutation
object
4 properties 2 required
Model94
string
NotFoundError
object
3 properties 2 required
error
string
PublicStatusPageV3IncidentsPaginatedResponse
object
3 properties 2 required
PublicStatusPageV3ComponentImpactsResponse
array
Model4
string
Model1
string
PublicStatusPageV3IncidentStatus
string
Model92
string
PublicStatusPageV3IncidentCreateUpdates
array
Exactly one update: the one that opens the incident.
PublicStatusPageV3IncidentUpdates
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-status-pages-v3-incidents-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 Maintenance Windows API
Where this information came from

This is an independent, third-party profile of Checkly Status Pages V3 Incidents 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.