Sign in
Status Page

Update incident status

Changed on
patch/incidents/{incident_id}/status

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/incidents/{incident_id}/status
  • Auth: HTTP bearer

Path parameters

incident_idinteger required

Incident ID

Request body

is_publicboolean

Show this update on the project's published status pages. Defaults to false: incident updates are private unless explicitly made public.

messagestring required
statusstring required

Response

Incident status updated successfully

created_atstring date-time required
descriptionstring nullable
environment_idinteger nullable
idinteger required
monitor_idinteger nullable
project_idinteger required
resolved_atstring date-time nullable
severitystring required
started_atstring date-time required
statusstring required
titlestring required
updated_atstring date-time required

Changes