API reference
/v1/admin/status-page5 operations
← All groups · First call? Read the tutorial: auth, permissions, requests and responses, common failures
| Method | Path | Summary | Auth |
|---|---|---|---|
| GET | /v1/admin/status-page | Read the status page editor view | Session |
| PUT | /v1/admin/status-page | Save the status page settings and components | Session |
| POST | /v1/admin/status-page/incidents | Create an incident or a scheduled maintenance | Session |
| DELETE | /v1/admin/status-page/incidents/{incident_id} | Delete an incident | Session |
| POST | /v1/admin/status-page/incidents/{incident_id}/updates | Add an update to an incident | Session |
Contract file：api/control-status-page.openapi.yaml
/v1/admin/status-pageRead the status page editor view
| Status | Description |
|---|---|
200 | Settings Fields： |
401 | Error |
403 | Error |
503 | Error |
401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.503 A dependency is unavailable: retry later with the original Idempotency-Key./v1/admin/status-pageSave the status page settings and components
| Name | In | Type | Required | Description |
|---|---|---|---|---|
If-Match | header | string | Yes | — |
application/json · Required：Yes
| Name | Type | Required | Description |
|---|---|---|---|
settings | SettingsInput | Yes | — |
components | array<ComponentInput> | Yes | — |
| Status | Description |
|---|---|
200 | Saved view Fields： |
400 | Error |
401 | Error |
403 | Error |
409 | Duplicate component name |
412 | Revision conflict |
428 | If-Match revision is missing |
503 | Error |
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.412 The revision changed: read the latest ETag, decide again, then send the new If-Match.428 A precondition is missing: read the resource and send If-Match (or the required proof).503 A dependency is unavailable: retry later with the original Idempotency-Key./v1/admin/status-page/incidentsCreate an incident or a scheduled maintenance
application/json · Required：Yes
| Name | Type | Required | Description |
|---|---|---|---|
kind | string: incident / maintenance | Yes | — |
title | string | Yes | — |
impact | string | No | Required for an incident (degraded or outage); ignored for maintenance, which is always maintenance. |
status | string: investigating / identified / monitoring / resolved / scheduled / in_progress / completed | No | Incident: investigating, identified, monitoring or resolved (default investigating). Maintenance: scheduled, in_progress or completed (default scheduled). |
message | string | Yes | — |
component_ids | array<string(uuid)> | No | — |
scheduled_start | string(date-time) | No | Maintenance only, required there. |
scheduled_end | string(date-time) | No | Maintenance only, required there; after scheduled_start, at most 30 days after it, and in the future. |
| Status | Description |
|---|---|
201 | Created Fields： |
400 | Error |
401 | Error |
403 | Error |
503 | Error |
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.503 A dependency is unavailable: retry later with the original Idempotency-Key./v1/admin/status-page/incidents/{incident_id}Delete an incident
| Name | In | Type | Required | Description |
|---|---|---|---|---|
incident_id | path | string(uuid) | Yes | — |
| Status | Description |
|---|---|
204 | Deleted |
401 | Error |
403 | Error |
404 | Error |
503 | Error |
401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.503 A dependency is unavailable: retry later with the original Idempotency-Key./v1/admin/status-page/incidents/{incident_id}/updatesAdd an update to an incident
| Name | In | Type | Required | Description |
|---|---|---|---|---|
incident_id | path | string(uuid) | Yes | — |
application/json · Required：Yes
| Name | Type | Required | Description |
|---|---|---|---|
status | string: investigating / identified / monitoring / resolved / scheduled / in_progress / completed | Yes | Must belong to the incident's kind. |
message | string | Yes | — |
| Status | Description |
|---|---|
200 | Updated incident Fields： |
400 | Error |
401 | Error |
403 | Error |
404 | Error |
409 | The incident is already resolved or the maintenance completed |
503 | Error |
400 Fix the parameters or body per the field list; do not retry unchanged.401 Check the credential format and whether it expired or was rotated.403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.404 The resource does not exist or belongs to another tenant.409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.503 A dependency is unavailable: retry later with the original Idempotency-Key.