HOhoneybadger
Incidents

Create an incident update

Posts an update to an incident.

post/status_pages/{status_page_id}/incidents/{incident_id}/updates

Request

Path parameters

status_page_idstring required
Example:Sp7bMq

Status page ID

incident_idstring required
Example:In3pKr

Incident ID

Request body

messagestring

The update's prose

status'maintenance_scheduled' | 'in_maintenance' | 'maintenance_complete' | 'investigating' | 'identified' | 'resolving' | 'monitoring' | 'resolved'

An incident's status.

severity'problem_detected' | 'degraded_performance' | 'partial_outage' | 'outage' | 'operational'

An incident's severity.

start_atstring date-time

When the update takes effect. Only a scheduled_maintenance incident may set this in the future.

start_nowboolean

Start the update immediately, ignoring start_at. An update that has already started is left as it is, so sending it again changes nothing.

should_notifyboolean

Announce the update on the status page's connected accounts and email the status page's subscribers

Example request

{
  "message": "We have identified the cause and are rolling back."
}

Response

Update created

Example response

{
  "data": {
    "id": "Iu6tMn",
    "incident_id": "In3pKr",
    "message": "We have identified the cause and are rolling back."
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

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