Update a status page
Updates selected status-page settings, including branding, publication, appearance, notifications, history and public address.
Parameters
| Field | Type | Description |
|---|---|---|
pageID required | uuid | path parameter |
Body
The 5 fields most calls use come first; the rest are grouped below.
Appearance23 fields
Layout and brand surface. Omitted leaves the stored value unchanged (on create: none chosen), null resets it to the default design, an object is validated and stored: version must be 1, layout is required, ground defaults to paper, header_light and header_dark are #RRGGBB or empty.
Nested fields 5 fields
| Field | Type | Description |
|---|---|---|
ground optional | string one ofpaperwhitecool | Empty is stored as paper. |
header_dark optional | string | #RRGGBB or empty for the platform default. |
header_light optional | string | #RRGGBB or empty for the platform default. |
layout optional | string one ofessentialbrandoverview | |
version optional | integer | Must be 1. |
No effect since Plan 82; accepted and stored only.
Nested fields 4 fields
| Field | Type | Description |
|---|---|---|
apply_assets optional | boolean | Replaces the page's images (and logo_url) with the template's. |
apply_css optional | boolean | Fills custom_css from the template when the request sets none. |
expected_revision optional | integer | The template revision the caller looked at (at least 1); a different stored revision is a conflict. |
template_id optional | uuid |
No effect since Plan 82; accepted and stored only.
Not supported: a non-empty value is rejected.
Not supported: a non-empty value is rejected; empty clears it.
Publication and notifications8 fields
Access and history6 fields
Write-only; an empty value keeps the current password. Responses carry password_protected only.
Ignored. Connect a domain with PUT /status-pages/{pageID}/custom-domain.
Returns
A successful request returns 200 with application/json.
Response fields 1 top-level fields
| Field | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | StatusPage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusPage · 61 fields
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Errors
Only the errors this operation can return. Every error uses the same envelope.
| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | The request is malformed or fails validation. |
| 409 | design_template_conflict | The design template was changed after the caller read it. When: Updating or applying a design template that was changed after the caller read it. Fix: Reload the template and apply the change again. |
| 404 | design_template_not_found | The design template does not exist or is not visible to the caller. When: A design template id in the path or body that is unknown or not visible to the caller. Fix: List design templates and use an id from the list. |
| 404 | not_found | The requested resource does not exist or is outside the caller's scope. |
| 403 | permission_denied | The credentials do not permit this action. |
Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.