Incidents

Post an incident update

Adds what's known now to the timeline, optionally with a new status, and shares it like an update from the dashboard.

post/incidents/{incident}/updates

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

incidentstring uuid required

Incident ID.

Request body

bodystring required

What's known now, in Markdown

status'investigating' | 'identified' | 'monitoring' | 'resolved'

Where an incident stands.

investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.

Example request

{
  "body": "Rolled back the deploy; error rates are dropping."
}

Response

The posted update.

idstring uuid required

Update ID

status'investigating' | 'identified' | 'monitoring' | 'resolved' required

Where an incident stands.

investigating <br/> Declared; the cause isn't known yet.
identified <br/> Acknowledged: the cause is known and someone works on it.
monitoring <br/> A fix is out; watching whether it holds.
resolved <br/> Over.
bodystring required

The update, in Markdown

created_atstring date-time required

When it was posted

Example response

{
  "body": "Rolled back the deploy; error rates are dropping."
}

Changes

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