CHchecklyhq
Status Pages

Retrieve a single status page by id.

Changed on

Get status page data, including cards and services.

Use the Status Pages v3 API for new integrations.

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

Example response

{
  "projectBindings": {
    "owner": {
      "binding": {
        "logicalId": "homepage-check",
        "sourceFile": "src/__checks__/homepage.check.ts"
      }
    },
    "references": [
      {
        "binding": {
          "logicalId": "homepage-check",
          "sourceFile": "src/__checks__/homepage.check.ts"
        }
      }
    ]
  }
}

Changes

  • bc90d1bfa738Revision changes
    • info

      added the optional property to the response with the status

  • aba5d34c749bRevision changes
    • info

      endpoint deprecated

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property //// to the response with the status