Documentation is now available for the Fall 2020 Update release!

Get alert escalation policy

This endpoint is used to retrieve an alert escalation policy of an organization by its policy id.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/escalations/{id}

Sample URLs

https://{api-url}/api/v2/tenants/msp_5/escalations/POLICY-a0250f66-bf3a-7568-edef-83e7e8ac4231
https://{api-url}/api/v2/tenants/client_7/escalations/POLICY-e231dcc6-b338-466e-afc4-6638fc6de9a9

Header format

HeaderValue
AuthorizationBearer {accessToken}
Content-typeapplication/json
Acceptapplication/json

Status code

200 OK

Parameters

FieldDescription
scopeEscalates alerts to the users, user groups, and rosters who belongs to the organization contained in the scope of the response.
rostersRoster is a list of users part of the schedule doing particular duty. Used to defined different resources to apply the escalate alert policy.
escalationTypeEscalation rules are actions taken when an alert is not acknowledged within the desired time. Supported types:
  • MANUAL - Contact users directly as needed.
  • AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED - Automated notifications via recipient users until acknolwedged, closed, suppressed, or ticketed.
  • AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED - Automated notifications via recipient users until acknolwedged, closed, or suppressed.
.
action
  • NOTIFICATION
  • INCIDENT
Escalation action to take
  • Escalate as Notification implies to send periodic notifications to users until the alert is acknowledged.
  • Escalate as Incident implies to automatically create an incident from the alert and assign to the desired user/team.
escalationsInformation about the escalation actions. Used to defined the users for escalated alerts notifications.
waitMinsThe time interval to escalate an alert after generation. Escalate after the alert has elapsed the set time.
repeatFrequencyThe time interval when a user receives repeated notifications.
This example indicates that a user receives repeated notifications every 15 minutes: repeatFrequency: 15.
notifyLimitCountA threshold limit on the number of notifications a user receives.
Example: notifyLimitCount: 5
alertStateTransitionFromFor every change in the alert state, user receives notifications.
recipients
  • For escalationType: MANUAL- Users to contact directly. User ID (or) name.
  • For escalationType: AUTOMATIC- Recipients who receives notifications.
allClientsThis string helps to differentiate between partner and client escalation policies. allClients: true indicates the policy is a partner level policy.
machineLearning
  • learnedFieldsToOutputColumnsMap"Assignee Group": "incident.assigneeGroup","Priority": "incident.priority"
This string indicates that machine-learning is enabled to automatically escalate an incident to appropriate teams.
  • Machine-learning enabled incident attributes:
    Example: Assignee Group, Priority
    • "Assignee Group" is the Incident attribute and "incident.assigneeGroup" is the respective output column in a CSV file.

Sample responses

{
	"id": "POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7",
	"name": "Test escalations",
	"description": "",
	"policyType": "ESCALATION_POLICY",
	"clientMatchingType": "ALL",
	"createdDate": "2017-05-15T12:13:31+0000",
	"updatedDate": "2017-05-15T12:13:31+0000",
	"active": true,
	"enabledMode": "ON",
	"scope": {
		"uniqueId": "msp_5",
		"name": "Test Partner",
		"activated": true
	},
	"createdBy": {
		"loginName": "superadmin",
		"lastName": "Test",
		"firstName": "tester",
		"email": "tester@opsramp.com"
	},
	"updatedBy": {
		"loginName": "superadmin",
		"lastName": "Test",
		"firstName": "tester",
		"email": "tester@opsramp.com"
	},
	"allClients": true,
	"resources": [
		{
		    "id": "d7bfffe6-03a4-48db-b6e2-a5aa8d5f28d4",
		    "name": "Device11",
		    "type": "RESOURCE",
		    "resourceType": "RESOURCE",
		    "aliasName": "",
		    "resourceName": "",
		    "hostName": "Device11"
		},
		{
		    "id": "59d820d3-7a64-4329-ba9c-bb9c14a4815c",
		    "name": "Device12",
		    "type": "RESOURCE",
		    "resourceType": "RESOURCE",
		    "aliasName": "",
		    "resourceName": "",
		    "hostName": "Device12"
		}
   	 ],
	"filterCriteria": {
		"matchingType": "ALL",
		"rules": [{
			"key": "Alert  : Description",
			"operator": "CONTAINS",
			"value": "critical"
		}]
	},
	"escalationType": "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED",
	"escalations": [{
			"waitMins": 0,
			"priority": "VeryLow",
			"repeatFrequency": 10,
			"notifyLimitCount": 2,
			"action": "NOTIFICATION",
			"recipients": [{
					"id": "ES-d16473ee-29de-1cf2-4983-86307733e34c",
					"name": "Test roster",
					"type": "ROSTER"
				},
				{
					"id": "USR0000000019",
					"name": "mani_partner",
					"type": "USER"
				}
			]
		},
		{
			"action": "INCIDENT",
			"waitMins": 5,
			"incident": {
				"status": "New",
				"priority": "Low",
				"assignedUser": {
					"loginName": "superadmin",
					"lastName": "Test",
					"firstName": "tester",
					"email": "tester@opsramp.com",
					"phoneNumber": "",
					"mobileNumber": "1234567890"
				},
				"customFields": [{
					"id": "UDF0000000002",
					"classCode": "INCIDENT",
					"displayLabel": "Test Cutom",
					"name": "test_cutom_2",
					"fieldType": "TYPE_TEXT",
					"mandatory": false,
					"editable": true,
					"description": "",
					"value": "Test1",
					"defaultValue": "",
					"customField": true
				}],
				"businessImpact": {
					"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f",
					"name": "Impact 3",
					"description": "SP Level Impact"
				},
				"urgency": {
					"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10",
					"name": "Urgency 3",
					"description": "SP Level Urgency"
				},
				"toEmail": "tester1@opsramp.com",
				"machineLearning": {
				    "continuousLearning": false,
		            "learnedFieldsToOutputColumnsMap": {
		            "Assignee Group": "incident.assigneeGroup",
		            "Priority": "incident.priority"
		          }
		        }
			},
			"updateIncident": {
				"none": true,
				"priorityRules": [{
					"key": "currentState.code",
					"operator": "Is",
					"value": "Warning",
					"businessImpact": {
						"uniqueId": "SIMPACT-d8853b21-ebc5-dd1d-d9a3-7a7b121ae0e",
						"name": "Test Ops impact",
						"description": ""
					},
					"urgency": {
						"uniqueId": "SURG-59358506-4bf1-4d35-c902-de3b14a00c10",
						"name": "Test Ops urgency",
						"description": ""
					},
					"priority": "High"
				}]
			},
			"notifyIncident": "forEveryUpdate"
		}
	]
}