Cloud
Jira Service Management ops / Reference / REST API

Escalations

Postman Collection
OpenAPI

Escalation policies can be used to notify multiple users/teams/schedules in order till the alert is acknowledged by someone. This resource represents the contract to create/update/delete/get of escalations in Jira Service Management.

GET

List escalationsExperimental

Lists all escalations under given team. It optionally takes two parameters - offset and size.

Request

Path parameters

teamId

string

Required

Query parameters

offset

integer

size

integer

Responses

Returned if the request is successful.

application/json

EscalationPaginatedResponse
GET/v1/teams/{teamId}/escalations
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/escalations' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 { "values": [ { "id": "69291859-ed73-4396-8b74-c61a3c810cdf", "name": "FE Daily On-call Escalation", "description": "Your primary responsibilities include handling unexpected incidents that impact the functionality or performance of the frontend", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } } ], "links": { "next": "/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/escalations?offset=10&size=5" } }
POST

Create escalationExperimental

Creates an escalation with the given properties.

Request

Path parameters

teamId

string

Required

Request bodyapplication/json

name

string

Required
description

string

rules

array<EscalationRule>

Required
enabled

boolean

repeat

EscalationRepeat

Responses

Returned if the request is successful.

application/json

EscalationResponse
POST/v1/teams/{teamId}/escalations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 curl --request POST \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/escalations' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "FE Daily On-call Escalation", "description": "", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } }'
201Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "id": "69291859-ed73-4396-8b74-c61a3c810cdf", "name": "FE Daily On-call Escalation", "description": "Your primary responsibilities include handling unexpected incidents that impact the functionality or performance of the frontend", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } }
GET

Get escalationExperimental

Gets an escalation with given id in the request.

Request

Path parameters

teamId

string

Required
id

string

Required

Responses

Returned if the request is successful.

application/json

EscalationResponse
GET/v1/teams/{teamId}/escalations/{id}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/escalations/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "id": "69291859-ed73-4396-8b74-c61a3c810cdf", "name": "FE Daily On-call Escalation", "description": "Your primary responsibilities include handling unexpected incidents that impact the functionality or performance of the frontend", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } }
DEL

Delete escalationExperimental

Deletes an escalation with given id in the request.

Request

Path parameters

teamId

string

Required
id

string

Required

Responses

Returned if the request is successful

DEL/v1/teams/{teamId}/escalations/{id}
1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/escalations/{id}' \ --user 'email@example.com:<api_token>'
PATCH

Update escalationExperimental

Updates an escalation with given id in the request.

Request

Path parameters

teamId

string

Required
id

string

Required

Request bodyapplication/json

name

string

description

string

rules

array<EscalationRule>

enabled

boolean

repeat

EscalationRepeat

Responses

Returned if the request is successful.

application/json

EscalationResponse
PATCH/v1/teams/{teamId}/escalations/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 curl --request PATCH \ --url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/teams/{teamId}/escalations/{id}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "FE Daily On-call Escalation", "description": "", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "id": "69291859-ed73-4396-8b74-c61a3c810cdf", "name": "FE Daily On-call Escalation", "description": "Your primary responsibilities include handling unexpected incidents that impact the functionality or performance of the frontend", "rules": [ { "condition": "if-not-acked", "notifyType": "default", "delay": 5, "recipient": { "id": "f0f07a3d-bde8-4b2a-8d3e-f97020a51e32", "type": "team" } } ], "enabled": true, "repeat": { "waitInterval": 10, "count": 5, "resetRecipientStates": true, "closeAlertAfterAll": true } }