Sign in
Status Pages

Create a new status page.

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

post/v1/status-pages

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

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

Changed in 2 of the 4 revisions of this API.4

  • 87d29dc7b4fe2See the full diff
    • ○

      added the new optional request property logoDark

      new-optional-request-property

    • ○

      added the optional property logoDark to the response with the 201 status

      response-optional-property-added

    This revision also has 566 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9e903da4f3da2See the full diff
    • ○

      added the new optional request property version

      new-optional-request-property

    • ○

      added the optional property version to the response with the 201 status

      response-optional-property-added