---
title: "Create a status page"
method: POST
path: "/status_pages"
tags: ["Status pages"]
---

# Create a status page

`POST /status_pages`

## Request

- Base URL: `https://app.honeybadger.io/v3`
- URL: `https://app.honeybadger.io/v3/status_pages`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/honeybadger/apis/honeybadger-api/docs/status_pages/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a status page.

## Request body

- StatusPageCreateInput: Writable status-page attributes. Omitted fields are unchanged; null resets or clears the fields marked nullable. Read-only fields, including each monitor's state, are ignored.
  - `name` string, required
  - `domain` string, nullable: Custom domain the page is served on. Unique across Honeybadger. An account can set at most 30 domains a week. Null clears it.
  - `incidents_enabled` boolean, nullable: Whether the page shows incidents. Changing it requires status page incidents on the plan. On create, defaults to whether the plan has them. Null resets it to that same create default.
  - `search_engine_indexing_disabled` boolean, nullable: Asks search engines not to index the page. Null resets it to false.
  - `message_enabled` boolean, nullable: Shows the message banner. Null resets it to false.
  - `message_title` string, nullable: The message banner's title. Null clears it.
  - `message_body` string, nullable: The message banner's text. Null clears it.
  - `google_analytics_id` string, nullable: A Google Analytics measurement ID for the page. Null clears it.
  - `hide_branding` boolean, nullable: Changing it requires advanced status pages on the plan; the default (false) or the stored value is accepted on any plan. Null resets it to false.
  - `password_protected` boolean, nullable: Changing it requires advanced status pages and password protection on the plan; the default (false) or the stored value is accepted on any plan. Turning it on needs a username and password, sent or already stored. Null resets it to false.
  - `username` string, nullable: Basic-auth user when password protected. Requires advanced status pages and password protection on the plan.
  - `password` string, password, nullable: Basic-auth password when password protected. Never returned. Requires advanced status pages and password protection on the plan.
  - `features` StatusPageFeatures: Presentation copy and styling. Replaced whole by an update. A key that was never set is absent from a read; one sent as null reads back as null.
    - `home_link` string, nullable: URL the page header links to, usually your own site.
    - `up_caption` string, nullable: Text shown when every check is up. Unset, the page says "All systems are operational".
    - `down_caption` string, nullable: Text shown when every check is down. Unset, the page says "All systems are experiencing issues".
    - `mixed_caption` string, nullable: Text shown when only some checks are down. Unset, the page says "Some systems are experiencing issues".
    - `custom_css` string, nullable: CSS added to the page after its own styles.
  - `sites` StatusPageSiteInput[], nullable: Sites listed on the page, in page order, replacing the current list. Null or empty removes every site.
    - `site_id` string, uuid, required: Identifier of a site on this account
    - `display_name` string, nullable: null uses the monitor's own name; "" is refused.
    - `description` string, nullable: null shows no description; "" is refused.
  - `check_ins` StatusPageCheckInInput[], nullable: Check-ins listed on the page, in page order, replacing the current list. Null or empty removes every check-in.
    - `check_in_id` string, required: ID of a check-in on this account
    - `display_name` string, nullable: null uses the monitor's own name; "" is refused.
    - `description` string, nullable: null shows no description; "" is refused.

## Response `201`

Status page created

- object
  - `data` StatusPage, required: A public status page. Readable and deletable after the plan loses status pages; creating and editing need the feature.
    - `id` string, required
    - `account_id` string, required: ID of the account this status page belongs to
    - `name` string, required: Status page name
    - `domain` string, nullable, required: Custom domain for the status page
    - `features` StatusPageFeatures, required: Presentation copy and styling. Replaced whole by an update. A key that was never set is absent from a read; one sent as null reads back as null.
      - `home_link` string, nullable: URL the page header links to, usually your own site.
      - `up_caption` string, nullable: Text shown when every check is up. Unset, the page says "All systems are operational".
      - `down_caption` string, nullable: Text shown when every check is down. Unset, the page says "All systems are experiencing issues".
      - `mixed_caption` string, nullable: Text shown when only some checks are down. Unset, the page says "Some systems are experiencing issues".
      - `custom_css` string, nullable: CSS added to the page after its own styles.
    - `hide_branding` boolean, required
    - `password_protected` boolean, required
    - `username` string, nullable, required: Basic-auth user when password protected. The password is never returned.
    - `incidents_enabled` boolean, required: Whether the page shows incidents
    - `search_engine_indexing_disabled` boolean, required: Whether search engines are asked not to index the page
    - `message_enabled` boolean, required: Whether the message banner shows
    - `message_title` string, nullable, required: The message banner's title
    - `message_body` string, nullable, required: The message banner's text
    - `google_analytics_id` string, nullable, required: The page's Google Analytics measurement ID
    - `url` string, required: URL of the status page
    - `created_at` string, date-time, required: When the status page was created
    - `domain_verified_at` string, date-time, nullable, required: When the custom domain was verified
    - `sites` StatusPageSite[], required: Uptime sites displayed on the status page. An ordered list; the order is the order on the page.
      - `site_id` string, uuid, required: Identifier of the site
      - `display_name` string, nullable, required: Display name on the status page
      - `description` string, nullable, required: Description shown on the status page
    - `check_ins` StatusPageCheckIn[], required: Check-ins displayed on the status page. An ordered list; the order is the order on the page.
      - `check_in_id` string, required: ID of the check-in
      - `display_name` string, nullable, required: Display name on the status page
      - `description` string, nullable, required: Description shown on the status page
    - `links` WebLinks, required: Links into the Honeybadger web UI
      - `web` string, uri, required: The resource's page in the Honeybadger web UI, as an absolute URL. Resources without a page, such as outages and deploys, don't have `links`. For a project provisioned through Heroku, error, notice and comment links go through Heroku's single sign-on.
  - `meta` ResponseMeta
    - `request_id` string: Unique identifier for the request, for correlating with support

## Other responses

- `401`: The credential is missing, invalid, expired or revoked (`unauthorized`), or was sent in a way v3 doesn't accept (see the examples).
- `403`: The credential isn't allowed to do this. `error.code` says why. An account or project the credential doesn't cover is 404 `not_found`, not 403.
- `422`: Validation error

---

[API](https://skmtc.dev/honeybadger/apis/honeybadger-api.md) - [All operations](https://skmtc.dev/honeybadger/apis/honeybadger-api/llms.txt) - [OpenAPI document](https://skmtc.dev/honeybadger/apis/honeybadger-api/revisions/cbcff53f2c8a?raw)