SPspectate
Incidents

Assign an incident role

Gives the role to a member of the team, replacing whoever had it.

put/incidents/{incident}/roles/{role}

Request

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

Path parameters

incidentstring uuid required

Incident ID.

role'commander' | 'communications_lead' required

A role in handling an incident; one member each.

commander <br/> Leads the response and makes the calls.
communications_lead <br/> Keeps customers and the company informed, for example through the status page.

The role.

Request body

member_idstring uuid required

The member who takes the role; they replace whoever had it

Response

The incident with its roles.

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.