---
title: "Create a new status page."
method: POST
path: "/v1/status-pages"
tags: ["Status Pages"]
---

# Create a new status page.

`POST /v1/status-pages`

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

## Headers

- `x-checkly-account` string — Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

## Request body

- StatusPageV2PublicApiUpdate
  - `name` string, required
  - `description` string, nullable
  - `url` string, required
  - `customDomain` string, nullable — A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
  - `themeColors` StatusPageV2ThemeColors, nullable
    - `light` StatusPageThemeColors, required
      - `bodyBackgroundColor` string, required
      - `headerBackgroundColor` string, required
      - `headerFontColor` string, required
      - `titleFontColor` string, required
      - `bodyFontColor` string, required
      - `bodyFontColorMuted` string, required
      - `navigationFontColor` string, required
      - `linkFontColor` string, required
      - `cardBackgroundColor` string, required
      - `borderColor` string, required
      - `primaryButtonBackgroundColor` string, required
      - `primaryButtonFontColor` string, required
    - `dark` StatusPageThemeColors, required
      - `bodyBackgroundColor` string, required
      - `headerBackgroundColor` string, required
      - `headerFontColor` string, required
      - `titleFontColor` string, required
      - `bodyFontColor` string, required
      - `bodyFontColorMuted` string, required
      - `navigationFontColor` string, required
      - `linkFontColor` string, required
      - `cardBackgroundColor` string, required
      - `borderColor` string, required
      - `primaryButtonBackgroundColor` string, required
      - `primaryButtonFontColor` string, required
  - `logo` string, nullable
  - `redirectTo` string, nullable
  - `favicon` string, nullable
  - `defaultTheme` 'LIGHT' | 'DARK' | 'AUTO'
  - `version` number, nullable
  - `cards` StatusPageV2CardUpdate[], required
    - `id` string
    - `statusPageId` string
    - `name` string, required
    - `services` StatusPageV2CardServiceRef[]
      - `id` string

## Response `201`

Created

- StatusPageV2WithId
  - `name` string, required
  - `description` string, nullable
  - `url` string, required
  - `customDomain` string, nullable — A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.
  - `themeColors` StatusPageV2ThemeColors, nullable
    - `light` StatusPageThemeColors, required
      - `bodyBackgroundColor` string, required
      - `headerBackgroundColor` string, required
      - `headerFontColor` string, required
      - `titleFontColor` string, required
      - `bodyFontColor` string, required
      - `bodyFontColorMuted` string, required
      - `navigationFontColor` string, required
      - `linkFontColor` string, required
      - `cardBackgroundColor` string, required
      - `borderColor` string, required
      - `primaryButtonBackgroundColor` string, required
      - `primaryButtonFontColor` string, required
    - `dark` StatusPageThemeColors, required
      - `bodyBackgroundColor` string, required
      - `headerBackgroundColor` string, required
      - `headerFontColor` string, required
      - `titleFontColor` string, required
      - `bodyFontColor` string, required
      - `bodyFontColorMuted` string, required
      - `navigationFontColor` string, required
      - `linkFontColor` string, required
      - `cardBackgroundColor` string, required
      - `borderColor` string, required
      - `primaryButtonBackgroundColor` string, required
      - `primaryButtonFontColor` string, required
  - `logo` string, nullable
  - `redirectTo` string, nullable
  - `favicon` string, nullable
  - `defaultTheme` 'LIGHT' | 'DARK' | 'AUTO'
  - `cards` StatusPageV2Card[]
    - `id` string, required
    - `name` string, required
    - `services` StatusPageV2Service[]
      - `name` string, required
      - `id` string, required
      - `accountId` string, required
      - `created_at` string, date, required
      - `updated_at` string, date, nullable
    - `created_at` string, date, required
    - `updated_at` string, date, nullable
  - `version` number, nullable
  - `id` string, required
  - `whiteLabel` boolean
  - `isPrivate` boolean

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests

---

[API](https://skmtc.net/checklyhq/apis/checkly-public-api.md) · [All operations](https://skmtc.net/checklyhq/apis/checkly-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/checklyhq/checkly-public-api/revisions/9e903da4f3da/schema)