Create a status page update
Creates an incident, maintenance window or report with a title, status, timing, affected resources and optional notifications.
Parameters
| Field | Type | Description |
|---|---|---|
pageID required | uuid | path parameter |
Body
The 5 fields most calls use come first; the rest are grouped below.
Valid values depend on update_type: investigating, identified, monitoring or resolved for incidents; scheduled, in_progress, completed or cancelled for maintenance; published for reports. Defaults to the first of those.
incident (the default), maintenance or report. Ignored by POST /status-pages/{pageID}/reports, which always creates a report. The service does not validate it; any other value behaves like incident.
public (the default) or draft for a thread still being prepared.
Affected services3 fields
Monitors the update affects; read only when affected_resource_ids is empty.
Components (not monitors) the update affects. Wins over affected_monitor_ids when both are given.
pause_checks pauses the affected monitors for the window and needs starts_at and ends_at. Only for maintenance.
Timing6 fields
IANA time zone of the planned window. Only for maintenance.
Needs starts_at and ends_at. Only for maintenance.
Last day of the series (YYYY-MM-DD); empty means no end.
5 to 20160 minutes before the window starts; 0 switches the reminder off. Needs starts_at. Only for maintenance.
Automation4 fields
Backdates the display time of an incident or report; not in the future. Ignored for maintenance.
Returns
A successful request returns 201 with application/json.
Response fields 1 top-level fields
| Field | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | StatusPageUpdate | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusPageUpdate · 38 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. |
| 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. |
| 409 | documented response | idempotency_key_conflict: the Idempotency-Key was already used with a different request body; idempotency_replay_unavailable: the stored response can no longer be replayed for this credential or resource, refresh the state instead of retrying with a new key. |
Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.