SPspectate
Incidents

Declare an incident

It starts investigating. With Slack connected it's announced there like an incident declared in the dashboard, with its own channel when the Slack settings say so.

post/incidents

Request

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

Request body

titlestring required

What's going on, up to 255 characters

severity'critical' | 'high' | 'medium' | 'low' required

How urgent an alert or incident is. Escalation paths can branch on it.

critical <br/> Customers are affected right now.
high <br/> Serious, needs attention soon.
medium <br/> Should be looked at.
low <br/> Informational.
summarystring nullable

More about it, in Markdown

Example request

{
  "title": "Checkout fails for some customers"
}

Response

The new incident.

idstring uuid required

Incident ID

numberinteger nullable required

The team's sequence number: INC-42 is 42. null for some older incidents

referencestring required

The human reference

titlestring required

What's going on

summarystring nullable required

More about it, in Markdown

severity'critical' | 'high' | 'medium' | 'low' required

How urgent an alert or incident is. Escalation paths can branch on it.

critical <br/> Customers are affected right now.
high <br/> Serious, needs attention soon.
medium <br/> Should be looked at.
low <br/> Informational.
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.
started_atstring date-time required

When it started

acknowledged_atstring date-time nullable required

When someone acknowledged it

resolved_atstring date-time nullable required

When it was resolved

alert_idstring uuid nullable required

The alert that opened it, for incidents declared by an escalation path

created_atstring date-time required

When it was declared

Example response

{
  "number": 42,
  "reference": "INC-42",
  "title": "Checkout fails for some customers",
  "roles": [
    {
      "member": {
        "name": "Jane Doe",
        "email": "jane@example.com"
      }
    }
  ]
}

Changes

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