Severities V1

Manage incident severities.

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

Severities help categorise incidents, and communicate urgency/impact. You can use severities when filtering incidents in the dashboard, and in workflows and announcement rules.

List Severities V1

List all incident severities for an organisation.

Responses
200

OK response.

get/v1/severities
Request samples
Response samples
application/json
{
  • "severities": [
    ]
}

Create Severities V1

Create a new severity

Request
Request Body schema: application/json
required
description
required
string

Description of the severity

name
required
string <= 50 characters

Human readable name of the severity

rank
integer <int64>

Rank to help sort severities (lower numbers are less severe)

Responses
201

Created response.

post/v1/severities
Request samples
application/json
{
  • "description": "Issues with **low impact**.",
  • "name": "Minor",
  • "rank": 1
}
Response samples
application/json
{
  • "severity": {
    }
}

Delete Severities V1

Delete a severity

Request
path Parameters
id
required
string

Unique identifier of the severity

Example: 01FCNDV6P870EA6S7TK1DSYDG0
Responses
202

Accepted response.

delete/v1/severities/{id}
Request samples

Show Severities V1

Get a single incident severity.

Request
path Parameters
id
required
string

Unique identifier of the severity

Example: 01FCNDV6P870EA6S7TK1DSYDG0
Responses
200

OK response.

get/v1/severities/{id}
Request samples
Response samples
application/json
{
  • "severity": {
    }
}

Update Severities V1

Update an existing severity

Request
path Parameters
id
required
string

Unique identifier of the severity

Example: 01FCNDV6P870EA6S7TK1DSYDG0
Request Body schema: application/json
required
description
required
string

Description of the severity

name
required
string <= 50 characters

Human readable name of the severity

rank
integer <int64>

Rank to help sort severities (lower numbers are less severe)

Responses
200

OK response.

put/v1/severities/{id}
Request samples
application/json
{
  • "description": "Issues with **low impact**.",
  • "name": "Minor",
  • "rank": 1
}
Response samples
application/json
{
  • "severity": {
    }
}