GET
/
v1
/
status-pages
Retrieve all status pages.
curl --request GET \
  --url https://api.checklyhq.com/v1/status-pages \
  --header 'Authorization: <api-key>'
[
  {
    "name": "<string>",
    "url": "<string>",
    "customDomain": "<string>",
    "logo": "<string>",
    "redirectTo": "<string>",
    "favicon": "<string>",
    "defaultTheme": "AUTO",
    "cards": [
      {
        "id": "<string>",
        "name": "<string>",
        "services": [
          {
            "name": "<string>",
            "id": "<string>",
            "accountId": "<string>",
            "created_at": "2023-12-25",
            "updated_at": "2023-12-25",
            "checks": [
              {
                "id": "<string>",
                "name": "<string>"
              }
            ]
          }
        ],
        "created_at": "2023-12-25",
        "updated_at": "2023-12-25"
      }
    ],
    "id": "<string>"
  }
]

​
Overview

The List Status Pages endpoint returns all status pages configured in your Checkly account. Status pages provide public visibility into your service health and incident communications. Common Use Cases:
  • Status Page Management
  • Public Communication
  • Service Health Display
  • Incident Communication
Status pages are public-facing communications tools. Use them to maintain transparency with your users about service availability and ongoing incidents.

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

Response

Successful

​
name
string
required
​
url
string
required
​
id
string
required
​
customDomain
string

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

​
redirectTo
string
​
favicon
string
​
defaultTheme
enum<string>
default:AUTO
Available options:
LIGHT,
DARK,
AUTO
​
cards
object[]