Skip to main content
POST
/
v1
/
status-pages
Create a new status page.
curl --request POST \
  --url https://api.checklyhq.com/v1/status-pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "cards": [
    {
      "name": "<string>",
      "id": "<string>",
      "statusPageId": "<string>",
      "services": [
        {
          "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"
}
'
{
  "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

Body

application/json
​
name
string
required
​
url
string
required
​
cards
object[]
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
​
logo
string | null
​
redirectTo
string | null
​
favicon
string | null
​
defaultTheme
enum<string>
default:AUTO
Available options:
LIGHT,
DARK,
AUTO

Response

Created

​
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
​
logo
string | null
​
redirectTo
string | null
​
favicon
string | null
​
defaultTheme
enum<string>
default:AUTO
Available options:
LIGHT,
DARK,
AUTO
​
cards
object[]
​
whiteLabel
boolean