Sign in

v2

latestOpenAPI 3.0.02026-07-261859071.2 MB
Status Pages

Retrieve a single status page by id.

Get status page data, including cards and services.

get/v1/status-pages/{statusPageId}

Path parameters

statusPageIdstring required

Headers

x-checkly-accountstring

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

Successful

namestring required
descriptionstring nullable
urlstring required
customDomainstring nullable

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

logostring nullable
redirectTostring nullable
faviconstring nullable
defaultTheme'LIGHT' | 'DARK' | 'AUTO'
idstring required
whiteLabelboolean
isPrivateboolean