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 API

The Status Pages API from Checkly — 8 operation(s) for status pages.

Checkly Status Pages 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. The published artifact set on APIs.io includes an OpenAPI specification.

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

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

8 operations 5 paths 51 schemas 2 DELETE3 GET2 POST1 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 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 8

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

Status Pages 8
GET
/v1/status-pagesdeprecated
Retrieve all status pages.
getV1Statuspages 3 params → 200401403404429
POST
/v1/status-pagesdeprecated
Create a new status page.
postV1Statuspages 1 param body → 201401403404429
DELETE
/v1/status-pages/{statusPageId}deprecated
Delete a status page.
deleteV1StatuspagesStatuspageid 2 params → 204401403404429
GET
/v1/status-pages/{statusPageId}deprecated
Retrieve a single status page by id.
getV1StatuspagesStatuspageid 2 params → 200401403404429
PUT
/v1/status-pages/{statusPageId}deprecated
Update an existing status page.
putV1StatuspagesStatuspageid 2 params body → 200401403404429
GET
/v1/status-pages/{statusPageId}/subscriptionsdeprecated
Get all subscriptions for a specific status page
getV1StatuspagesStatuspageidSubscriptions 2 params → 200401403404429
POST
/v1/status-pages/{statusPageId}/subscriptions/bulkdeprecated
Bulk create subscriptions for a specific status page
postV1StatuspagesStatuspageidSubscriptionsBulk 2 params body → 201401403404429
DELETE
/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}deprecated
Delete a subscription belonging to a specific status page
deleteV1StatuspagesStatuspageidSubscriptionsSubscriptionid 3 params → 204401403404429

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are StatusPageV2Read (20 properties), StatusPageV2WithIdRead (16 properties), StatusPageV2WithId (15 properties), StatusPageV2PublicApiUpdate (12 properties). Each schema is shown below with its type and property counts.

attributes
object
ProjectBindingReferencesV1
array
Projects that use this resource without owning it; their deploys leave it alone. Empty when there are none.
BulkCreateSubscriptionsPayload
object
2 properties 1 required
StatusPageThemeColors
object
12 properties 12 required
Model81
string
The status of the created subscriptions.
IncidentUpdates
array
Model2
string
UnauthorizedError
object
4 properties 2 required
TooManyRequestsError
object
4 properties 2 required
StatusPageV2Card
object
5 properties 3 required
StatusPagesV2PaginatedResponse
object
3 properties 2 required
Model74
object
4 properties 3 required
StatusPageV2ThemeColors
objectnull
2 properties 2 required
StatusPageV2IncidentServices
object
9 properties 6 required
BulkCreateSubscriptionsResponse
object
3 properties 3 required
Model80
object
2 properties 2 required
StatusPageV2CardServiceRef
object
1 property
StatusPageV2Cards
array
StatusPageV2CardUpdate
object
4 properties 1 required
StatusPageV2CardUpdates
array
Model79
string
The type of subscription type, i.e. EMAIL.
ProjectBindingV1
object
2 properties 2 required
Model75
array
Model77
string
The type of subscription.
ForbiddenError
object
3 properties 2 required
StatusPageV2WithIdRead
object
16 properties 3 required
defaultTheme
string
SubscriptionsList
array
The list of subscriptions for the status page.
StatusPageV2CardServices
array
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
StatusPageV2IncidentUpdateWithId
object
6 properties 3 required
StatusPageV2Service
object
5 properties 4 required
StatusPageV2WithId
object
15 properties 3 required
Model78
string
The status of the subscription.
StatusPageV2PublicApiUpdate
object
12 properties 3 required
StatusPageV2Read
object
20 properties 5 required
NotFoundError
object
3 properties 2 required
subscriptions
array
The list of subscriptions to create (max 100).
error
string
StatusPageV2Incidents
array
IncidentSeverity
string
StatusPageV2CardServiceRefs
array
Model4
string
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
StatusPagesV2Entries
array
IncidentServices
array
StatusPageIncidentStatus
string
Subscription
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-status-pages-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 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.