IncidentStatuses V1

Manage incident statuses.

Each incident has a status, picked from one of the statuses configured in your organisations settings.

Statuses help communicate where an incident is in its lifecycle. You can use statuses when filtering incidents in the dashboard, and in workflows and announcement rules.

List IncidentStatuses V1

List all incident statuses for an organisation.

Responses
200

OK response.

get/v1/incident_statuses
Request samples 
Response samples 
application/json
{
  • "incident_statuses": [
    ]
}
Create IncidentStatuses V1
Create a new incident status


Request 
Request Body schema: application/json
category
required
string
Whether the status should be considered 'live' or 'closed'. The triage and declined statuses cannot be created or modified.


 Enum: "live" "learning" "closed"  
description
required
string
Rich text description of the incident status


 
name
required
string
Unique name of this status


 
Responses 
201
Created response.


post/v1/incident_statuses
Request samples 
application/json
{
  • "category": "live",
  • "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  • "name": "Closed"
}
Response samples 
application/json
{
  • "incident_status": {
    }
}
Delete IncidentStatuses V1
Delete an incident status


Request 
path Parameters
id
required
string
Unique ID of this incident status


 
 Example:  01FCNDV6P870EA6S7TK1DSYD5H
Responses 
202
Accepted response.


delete/v1/incident_statuses/{id}
Request samples 
Show IncidentStatuses V1
Get a single incident status.


Request 
path Parameters
id
required
string
Unique ID of this incident status


 
 Example:  01FCNDV6P870EA6S7TK1DSYD5H
Responses 
200
OK response.


get/v1/incident_statuses/{id}
Request samples 
Response samples 
application/json
{
  • "incident_status": {
    }
}
Update IncidentStatuses V1
Update an existing incident status


Request 
path Parameters
id
required
string
Unique ID of this incident status


 
 Example:  01FCNDV6P870EA6S7TK1DSYD5H
Request Body schema: application/json
description
required
string
Rich text description of the incident status


 
name
required
string
Unique name of this status


 
Responses 
200
OK response.


put/v1/incident_statuses/{id}
Request samples 
application/json
{
  • "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  • "name": "Closed"
}
Response samples 
application/json
{
  • "incident_status": {
    }
}
➔ Next to Incident Timestamps V2