Update status page

Replaces a status page's fields, including its monitor list. A missing or foreign id returns 404. Only fields this request actually changes are checked against the current plan — a preference set on a higher plan and left untouched survives a downgrade.

put/me/status-pages/{id}

Request

  • Base URL: https://app.yoping.me/api/v1
  • URL: https://app.yoping.me/api/v1/me/status-pages/{id}
  • Auth: API key in cookie yp_session

Path parameters

idstring required

Resource id. Ids belonging to another account behave as missing (404).

Request body

slugstring required

3-63 lowercase letters, digits, or hyphens; no leading/trailing hyphen. Reserved names (status, api, app, admin, www, mail, statuspage, yopingme, help, support, docs, blog) are rejected.

enabledboolean
titlestring
hide_brandingboolean

Requires a plan with hide_branding (422 plan_limit otherwise).

custom_domainstring nullable

Requires a plan with custom_domain (422 plan_limit otherwise).

monitor_idsstring[]

Monitors shown on the page, in order. Duplicates and unknown/foreign monitor ids are rejected.

Response

Status page updated.

Changes

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