Incident Roles V1

Manage incident roles.

During an incident, you can assign responders to one of the incident roles that are configured in your organisation settings.

Every organisation will have a special 'lead' role, which signifies the incident lead or commander. This role cannot be deleted, but can be renamed in the incident.io dashboard.

List Incident Roles V1

List all incident roles for an organisation.

Responses
200

OK response.

get/v1/incident_roles
Request samples 
Response samples 
application/json
{
  • "incident_roles": [
    ]
}
Create Incident Roles V1
Create a new incident role


Request 
Request Body schema: application/json
description
required
string  non-empty 
Describes the purpose of the role


 
instructions
required
string
Provided to whoever is nominated for the role


 
name
required
string  non-empty 
Human readable name of the incident role


 
required
required
boolean
Whether incident require this role to be set


 
shortform
required
string  non-empty 
Short human readable name for Slack


 
Responses 
201
Created response.


post/v1/incident_roles
Request samples 
application/json
{
  • "description": "The person currently coordinating the incident",
  • "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  • "name": "Incident Lead",
  • "required": true,
  • "shortform": "lead"
}
Response samples 
application/json
{
  • "incident_role": {
    }
}
Delete Incident Roles V1
Removes an existing role


Request 
path Parameters
id
required
string
Unique identifier for the role


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
204
No Content response.


delete/v1/incident_roles/{id}
Request samples 
Show Incident Roles V1
Get a single incident role.


Request 
path Parameters
id
required
string
Unique identifier for the role


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Responses 
200
OK response.


get/v1/incident_roles/{id}
Request samples 
Response samples 
application/json
{
  • "incident_role": {
    }
}
Update Incident Roles V1
Update an existing incident role


Request 
path Parameters
id
required
string
Unique identifier for the role


 
 Example:  01FCNDV6P870EA6S7TK1DSYDG0
Request Body schema: application/json
description
required
string  non-empty 
Describes the purpose of the role


 
instructions
required
string
Provided to whoever is nominated for the role


 
name
required
string  non-empty 
Human readable name of the incident role


 
required
required
boolean
Whether incident require this role to be set


 
shortform
required
string  non-empty 
Short human readable name for Slack


 
Responses 
200
OK response.


put/v1/incident_roles/{id}
Request samples 
application/json
{
  • "description": "The person currently coordinating the incident",
  • "instructions": "Take point on the incident; Make sure people are clear on responsibilities",
  • "name": "Incident Lead",
  • "required": true,
  • "shortform": "lead"
}
Response samples 
application/json
{
  • "incident_role": {
    }
}
➔ Next to IncidentStatuses V1