Status Pages

Create a new status page.

Changed on

Create a new status page with its related services and cards.

Use the Status Pages v3 API for new integrations.

post/v1/status-pages

Request

Headers

x-checkly-accountstring

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

Request body

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'
versionnumber nullable

Response

Created

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'
versionnumber nullable
idstring required
whiteLabelboolean
isPrivateboolean

Changes