CHchecklyhq
Status Pages V3

Retrieve a single v3 status page by id.

Changed on

Get a v3 (components-based) status page. Components and automation rules have their own endpoints.

get/v3/status-pages/{statusPageId}

Request

Path parameters

statusPageIdstring required

Headers

x-checkly-accountstring

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
logoDarkstring nullable
redirectTostring nullable
faviconstring nullable
defaultTheme'LIGHT' | 'DARK' | 'AUTO'
privacyPolicyLinkstring nullable
termsOfServiceLinkstring nullable
supportLinkstring nullable
footerTextstring nullable
googleAnalyticsTagstring nullable
allowIndexingboolean
isPrivateboolean
idstring required
accountIdstring required
version3 required
created_atstring date required
updated_atstring date nullable

Changes