URL
GET https://{api-url}/api/v2/tenants/{tenantId}/alerts/{alertId}/escalations
Note
- A generated accessToken is required to have
alerts:read
scope for accessing this API. - This API provides minimal data. Use Get Escalation Policy for more information.
Sample URLs
https://{api-url}/api/v2/tenants/client_7/alerts/280/escalations
Parameters
Field | Description |
---|---|
scope | Escalates alerts to the users, user groups, and rosters who belongs to the organization contained in the scope of the response. |
rosters | Roster is a list of users part of the schedule. Rosters define list of users or user groups assigned to specific time slots. |
escalationType | Escalation rules are actions taken when an alert is not acknowledged within the desired time. Supported types:
|
escalations | Represents total action part of the escalate policy. |
action | Takes escalation action:
|
escalations | Information about the escalation actions. |
waitMins | The time interval before escalating an alert after generation. Escalate after the alert has elapsed the set duration in minutes. |
repeatFrequency | Repeat alert notification after specific time intervals. If repeatFrequency, for example, is 15 minutes, then the alert notification would repeat for every 15 minutes until the alert is acknowledged. |
recipients |
|
waitMins | Sends notification after defined minutes. |
repeatFrequency | Repeats the send Notification after the defined minutes. |
recipients | Represents total notify users details. |
Sample 1: Manual
This sample is a manual alert escalation policy sample response.
[
{
"id" : "POLICY-0a40ccc7-adf4-a5f1-02a1-6e37892ea63f",
"name" : "Test partner",
"description" : "",
"policyType" : "ESCALATION_POLICY",
"createdDate" : "2017-05-05T13:24:39+0000",
"updatedDate" : "2017-05-05T13:24:39+0000",
"active" : true,
"enabledMode": "ON",
"scope" : {
"uniqueId" : "msp_5",
"name" : "Test Partner",
"activated" : true
},
"escalationType" : "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED",
"escalations" : [
{
"waitMins" : 0,
"priority" : "VeryLow",
"action" : "NOTIFICATION",
"recipients" : [
{
"id" : "ES-d16473ee-29de-1cf2-4983-86307733e34c",
"name" : "Test roster",
"type" : "ROSTER"
},
{
"id" : "USR0000000028",
"name" : "AP_User",
"type" : "USER"
},
{
"id" : "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name" : "Cloud group",
"type" : "USERGROUP"
}
]
}
]
},
{
"id" : "POLICY-dbfd8922-1efe-3b4c-8881-aec1518cc2fc",
"name" : "Escalation",
"description" : "",
"policyType" : "ESCALATION_POLICY",
"createdDate" : "2017-05-05T13:25:23+0000",
"updatedDate" : "2017-05-15T11:08:06+0000",
"active" : true,
"enabledMode": "ON",
"scope" : {
"uniqueId" : "msp_5",
"name" : "Test Partner",
"activated" : true
},
"escalationType" : "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED",
"escalations" : [
{
"waitMins" : 0,
"priority" : "VeryLow",
"action" : "NOTIFICATION",
"recipients" : [
{
"id" : "ES-d16473ee-29de-1cf2-4983-86307733e34c",
"name" : "Test roster",
"type" : "ROSTER"
},
{
"id" : "USR0000000019",
"name" : "mani_partner",
"type" : "USER"
}
]
}
]
},
{
"id" : "POLICY-d5e46c52-15a4-4db2-8ec6-3f58972aa6af",
"name" : "Test for NOC",
"description" : "",
"policyType" : "ESCALATION_POLICY",
"createdDate" : "2017-05-15T10:51:56+0000",
"updatedDate" : "2017-05-15T10:51:56+0000",
"active" : true,
"enabledMode": "ON",
"scope" : {
"uniqueId" : "client_7",
"name" : "Test Client",
"activated" : true
},
"escalationType" : "MANUAL",
"escalations" : [
{
"action" : "NOTIFICATION",
"recipients" : [
{
"id" : "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name" : "Cloud roster",
"type" : "ROSTER"
},
{
"id" : "USR0000000028",
"name" : "Test_User",
"type" : "USER"
},
{
"id" : "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name" : "Cloud group",
"type" : "USERGROUP"
}
]
}
]
}
]
Sample 2: Machine learning-based
This sample is a machine learning-based alert escalation policy sample response.
[
{
"id":"POLICY-14d82994-a67e-463b-955a-37ff2eee7368",
"name":"ML_policy",
"description":"",
"policyType":"ESCALATION_POLICY",
"createdDate":"2018-12-18T12:04:36+0000",
"updatedDate":"2018-12-18T12:04:36+0000",
"active":true,
"enabledMode": "ON",
"scope":{
"id":9,
"uniqueId":"client_9",
"name":"Brocade Corp.",
"activated":true
},
"escalationType":"AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED",
"escalations":[
{
"action":"INCIDENT",
"waitMins":0,
"incident":{
"status":"New",
"priority":"Very Low",
"estimatedHours":0,
"timeSpent":0,
"estimatedMinutes":0,
"machineLearning":{
"continuousLearning":false,
"trainingFileId":"ml_alert_escalation_training",
"learnedFieldsToOutputColumnsMap":{
"Assignee Group":"incident.assigneeGroup",
"Priority":"incident.priority"
}
}
},
"updateIncident":{
"none":true
},
"notifyIncident":"forEveryUpdate"
}
]
}
]