Retrieve a single status page by id.

Get status page data, including cards and services.

GET /v1/status-pages/{statusPageId}

Try it

Retrieve a single status page by id.

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/status-pages/{statusPageId} \
  --header 'Authorization: Bearer <token>'

200

{
  "name": "<string>",
  "url": "<string>",
  "id": "<string>",
  "customDomain": "<string>",
  "themeColors": {
    "light": {
      "bodyBackgroundColor": "<string>",
      "headerBackgroundColor": "<string>",
      "headerFontColor": "<string>",
      "titleFontColor": "<string>",
      "bodyFontColor": "<string>",
      "bodyFontColorMuted": "<string>",
      "navigationFontColor": "<string>",
      "linkFontColor": "<string>",
      "cardBackgroundColor": "<string>",
      "borderColor": "<string>",
      "primaryButtonBackgroundColor": "<string>",
      "primaryButtonFontColor": "<string>"
    },
    "dark": {
      "bodyBackgroundColor": "<string>",
      "headerBackgroundColor": "<string>",
      "headerFontColor": "<string>",
      "titleFontColor": "<string>",
      "bodyFontColor": "<string>",
      "bodyFontColorMuted": "<string>",
      "navigationFontColor": "<string>",
      "linkFontColor": "<string>",
      "cardBackgroundColor": "<string>",
      "borderColor": "<string>",
      "primaryButtonBackgroundColor": "<string>",
      "primaryButtonFontColor": "<string>"
    }
  },
  "logo": "<string>",
  "redirectTo": "<string>",
  "favicon": "<string>",
  "defaultTheme": "AUTO",
  "cards": [
    {
      "id": "<string>",
      "name": "<string>",
      "created_at": "2023-12-25",
      "services": [
        {
          "name": "<string>",
          "id": "<string>",
          "accountId": "<string>",
          "created_at": "2023-12-25",
          "updated_at": "2023-12-25",
          "checks": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        }
      ],
      "updated_at": "2023-12-25"
    }
  ],
  "whiteLabel": true
}

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string

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

Path Parameters

statusPageId · string · required

Response

200

application/json

Successful

name · string · required

url · string · required

id · string · required

customDomain · string | null

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

themeColors · object

Show child attributes

themeColors. light · object · required

Show child attributes

themeColors.light. bodyBackgroundColor · string · required

themeColors.light. headerBackgroundColor · string · required

themeColors.light. headerFontColor · string · required

themeColors.light. titleFontColor · string · required

themeColors.light. bodyFontColor · string · required

themeColors.light. bodyFontColorMuted · string · required

themeColors.light. navigationFontColor · string · required

themeColors.light. linkFontColor · string · required

themeColors.light. cardBackgroundColor · string · required

themeColors.light. borderColor · string · required

themeColors.light. primaryButtonBackgroundColor · string · required

themeColors.light. primaryButtonFontColor · string · required

themeColors. dark · object · required

Show child attributes

themeColors.dark. bodyBackgroundColor · string · required

themeColors.dark. headerBackgroundColor · string · required

themeColors.dark. headerFontColor · string · required

themeColors.dark. titleFontColor · string · required

themeColors.dark. bodyFontColor · string · required

themeColors.dark. bodyFontColorMuted · string · required

themeColors.dark. navigationFontColor · string · required

themeColors.dark. linkFontColor · string · required

themeColors.dark. cardBackgroundColor · string · required

themeColors.dark. borderColor · string · required

themeColors.dark. primaryButtonBackgroundColor · string · required

themeColors.dark. primaryButtonFontColor · string · required

logo · string | null

redirectTo · string | null

favicon · string | null

defaultTheme · enum<string> · default: AUTO

Available options: LIGHT, DARK, AUTO

cards · object[]

Show child attributes

cards. id · string · required

cards. name · string · required

cards. created_at · string<date> · required

cards. services · object[]

Show child attributes

cards.services. name · string · required

cards.services. id · string · required

cards.services. accountId · string · required

cards.services. created_at · string<date> · required

cards.services. updated_at · string<date> | null

cards.services. checks · object[] | null

Show child attributes

cards.services.checks. id · string

cards.services.checks. name · string

cards. updated_at · string<date> | null

whiteLabel · boolean