HOhoneybadger
Status pages

Update a status page

Updates a status page's settings.

patch/status_pages/{status_page_id}

Request

Path parameters

status_page_idstring required
Example:Sp7bMq

Status page ID

Request body

namestring
domainstring 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_enabledboolean 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_disabledboolean nullable

Asks search engines not to index the page. Null resets it to false.

message_enabledboolean nullable

Shows the message banner. Null resets it to false.

message_titlestring nullable

The message banner's title. Null clears it.

message_bodystring nullable

The message banner's text. Null clears it.

google_analytics_idstring nullable

A Google Analytics measurement ID for the page. Null clears it.

hide_brandingboolean 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_protectedboolean 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.

usernamestring nullable

Basic-auth user when password protected. Requires advanced status pages and password protection on the plan.

passwordstring password nullable

Basic-auth password when password protected. Never returned. Requires advanced status pages and password protection on the plan.

Example request

{
  "name": "Acme Status",
  "domain": "status.example.com",
  "features": {
    "home_link": "https://www.example.com",
    "up_caption": "Everything is running smoothly",
    "down_caption": "We're working on an outage",
    "mixed_caption": "Some services are degraded",
    "custom_css": ".header { background: #1d4ed8; }"
  },
  "sites": [
    {
      "site_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
    }
  ],
  "check_ins": [
    {
      "check_in_id": "XZbIlD"
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "id": "Sp7bMq",
    "account_id": "Ab3kL9",
    "name": "Acme Status",
    "domain": "status.acme.com",
    "features": {
      "home_link": "https://www.example.com",
      "up_caption": "Everything is running smoothly",
      "down_caption": "We're working on an outage",
      "mixed_caption": "Some services are degraded",
      "custom_css": ".header { background: #1d4ed8; }"
    },
    "message_title": "Scheduled maintenance",
    "message_body": "We're upgrading our database on Saturday at 02:00 UTC.",
    "url": "https://acme.statuspage.honeybadger.io",
    "sites": [
      {
        "site_id": "9f8b6d2e-4c1a-4b7f-9e35-2a6c8d0f1b47",
        "display_name": "Website"
      }
    ],
    "check_ins": [
      {
        "check_in_id": "Ci5xWq",
        "display_name": "Nightly backup"
      }
    ],
    "links": {
      "web": "https://app.honeybadger.io/projects/Xk9mZp"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.