Status Pages V3

Create a new v3 status page.

Changed on

Create a new v3 status page. Add components afterwards via the components endpoints.

post/v3/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'
privacyPolicyLinkstring nullable
termsOfServiceLinkstring nullable
supportLinkstring nullable
footerTextstring nullable
googleAnalyticsTagstring nullable
allowIndexingboolean
isPrivateboolean

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