Endpoint
/api/v2/tenants/{tenantId}/escalations
Path Parameters
tenantIdstring
descriptionstring
(Optional) Escalation policy description.
escalationTypestring
Escalation rules are actions to be taken when an alert is not acknowledged within the desired time. OpsRamp supports manual and automatic escalation types. If escalation Type is Manual, then escalations would be: - recipients If escalation Type is Automatic, then escalations would be: - waitMins - action
escalationsarray
Child Parameters
- escalations.action
- Escalation action to be taken.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 it to the desired user or team.
- escalations.alertStateTransitionFrom
- Escalate alerts as notification on a change in alert state. For example, escalate alerts as notification when alert state changes from Warning to Critical. The notification is a one-time notification sent at the time of the state transition.
- escalations.incident
- Create New Incident: Configure the properties of an incident that will be created when an alert's condition matches with this policy.
- escalations.notifyIncident
- Notify users when incident is updated due to change in alert state.
- escalations.notifyLimitCount
- Number of repeated notifications a user has to receive within a certain time interval. For example, if repeatFrequency: 15 and notifyLimitCount: 5. The above example indicates that user receives notifications every 15 minutes and stops receiving after 5 notifications. When a notification limit count is not provided, the default notifyLimitCount is 2. Can be set from 1 to 10.
- escalations.priority
- Priority of the notification.
- escalations.recipients
- escalations.repeatFrequency
- Repeat alert notification at specific time intervals. Example: If repeatFrequency is set as 15 minutes, then the alert notification would repeat every 15 minutes until the alert is acknowledged. Convert hours to minutes. Acceptable values: 5 mins, 10 mins, 15 mins, 20 mins, 30 mins, 1 hour, 2 hours, 3 hours, 4 hours, 6 hours, 8 hours, 12 hours, 24 hours
- escalations.updateIncident
- Configure how to update an existing incident of an escalated alert. If an Open incident (other than Closed) is available for the alert, the incident gets updated instead of creating a new incident. Either "none" or "withAlertState" must be included
- escalations.waitMins
- Configure the time interval to escalate an alert after it is generated. Escalate after the alert has elapsed the set time. Convert hours and days to minutes and provide the minutes time format. Example: For 6 hours provide the value as 360 minutes. Acceptable values: 0 to 30 mins, 45 mins 1 to 6 hours, 12 hours 1 day, 3 days, 5 days, 7 days, 10 days
filterCriteriaobject
Child Parameters
- filterCriteria.matchingType
- (Optional) Define alert conditions for the policy. Only the filtered alerts are escalated. All the alerts on the resource will match this policy if NO condition is defined. Match ANY or ALL of the filter rules.
- filterCriteria.rules
- Conditions to filter the alerts.
namestring
Escalation policy name.
resourcesobject
Resources on which the policy would be applied.
Child Parameters
- resources.id
- Resource ID
- resources.type
- Resource type Example: DEVICE. Use the following APIs to fetch the resource types: - Search Devices or Get Minimal Details of Resources API to fetch the list of devices or resources in a client. - Get Child Device Groups and Get Root Level Device Groups to fetch the list of device groups. - Get Service Groups to fetch the list of service groups. - Search Sites to fetch the list of sites. - Search Clients to fetch the list of clients. Only partner users have permission to fetch the details of client.
{
"description": "Test description",
"escalationType": "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED",
"escalations": [
{
"action": "NOTIFICATION",
"notifyLimitCount": 2,
"priority": "Low",
"recipients": [
{
"id": "USR0000000028",
"name": "AP_User",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
},
{
"id": "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name": "Cloud roster",
"type": "ROSTER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Ops group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"id": "USR0000000030",
"loginName": "OpsAdmin"
},
"assigneeGroup": {
"name": "Test Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"businessImpact": {
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"cc": "tester1@opsramp.com",
"customFields": [
{
"id": "UDF0000000002",
"name": "test_cutom_2",
"value": "2"
},
{
"id": "UDF0000000004",
"name": "esc_custom_field_4",
"value": "request custom field - text"
}
],
"priority": "Very Low",
"toEmail": "tester2@opsramp.com",
"urgency": {
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
}
},
"notifyIncident": "whenAlertStateChanged",
"updateIncident": {
"none": "true",
"priorityRules": [
{
"businessImpact": {
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
},
"value": "Warning"
}
],
"withAlertState": "true"
},
"waitMins": 5
}
],
"filterCriteria": {
"matchingType": "ANY",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
},
{
"key": "Alert : Occurrence Frequency",
"operator": "GREATERTHANOREQUALTO",
"value": {
"frequency": "2",
"frequencyType": "hours",
"occurrences": "5"
}
},
{
"key": "Resource : Resource Type",
"operator": "MATCH",
"value": "DEVICE"
}
]
},
"name": "Create escalate alert policy API",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"type": "RESOURCE"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"type": "SERVICEGROUP"
},
{
"id": "7_AWS",
"type": "LOCATION"
},
{
"id": "client_7",
"type": "CLIENT"
}
]
}
{
"description": "Test description",
"escalationType": "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED",
"escalations": [
{
"action": "NOTIFICATION",
"notifyLimitCount": 2,
"priority": "Low",
"recipients": [
{
"id": "USR0000000028",
"name": "AP_User",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
},
{
"id": "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name": "Cloud roster",
"type": "ROSTER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Ops group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"id": "USR0000000030",
"loginName": "OpsAdmin"
},
"assigneeGroup": {
"name": "Test Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"businessImpact": {
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"cc": "tester1@opsramp.com",
"customFields": [
{
"id": "UDF0000000002",
"name": "test_cutom_2",
"value": "2"
},
{
"id": "UDF0000000004",
"name": "esc_custom_field_4",
"value": "request custom field - text"
}
],
"priority": "Very Low",
"toEmail": "tester2@opsramp.com",
"urgency": {
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
}
},
"notifyIncident": "whenAlertStateChanged",
"updateIncident": {
"none": "true",
"priorityRules": [
{
"businessImpact": {
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
},
"value": "Warning"
}
],
"withAlertState": "true"
},
"waitMins": 5
}
],
"filterCriteria": {
"matchingType": "ANY",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
},
{
"key": "Alert : Occurrence Frequency",
"operator": "GREATERTHANOREQUALTO",
"value": {
"frequency": "2",
"frequencyType": "hours",
"occurrences": "5"
}
},
{
"key": "Resource : Resource Type",
"operator": "MATCH",
"value": "DEVICE"
}
]
},
"name": "Create escalate alert policy API",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"type": "RESOURCE"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"type": "SERVICEGROUP"
},
{
"id": "7_AWS",
"type": "LOCATION"
},
{
"id": "client_7",
"type": "CLIENT"
}
]
}
{
"description": "Test description",
"escalationType": "MANUAL",
"escalations": [
{
"recipients": [
{
"id": "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name": "Cloud roster",
"type": "ROSTER"
},
{
"id": "USR0000000028",
"name": "AP_User",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
}
]
}
],
"filterCriteria": {
"matchingType": "ANY",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
}
]
},
"name": "Create escalate alert policy API for NOC",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"type": "RESOURCE"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"type": "SERVICEGROUP"
},
{
"id": "7_AWS",
"type": "LOCATION"
},
{
"id": "client_7",
"type": "CLIENT"
}
]
}
Responses
OK
activeboolean
clientMatchingTypestring
createdByobject
Child Parameters
- createdBy.email
- createdBy.firstName
- createdBy.lastName
- createdBy.loginName
createdDatestring
descriptionstring
enabledModestring
escalationTypestring
escalationsarray
Child Parameters
- escalations.action
- escalations.incident
- escalations.notifyIncident
- escalations.priority
- escalations.recipients
- escalations.repeatFrequency
- escalations.updateIncident
- escalations.waitMins
idstring
namestring
policyTypestring
updatedByobject
Child Parameters
- updatedBy.email
- updatedBy.firstName
- updatedBy.lastName
- updatedBy.loginName
updatedDatestring
{
"active": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "opsuser@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"createdDate": "2017-05-15T10:35:51+0000",
"description": "Test description",
"enabledMode": "ON",
"escalationType": "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED",
"escalations": [
{
"action": "NOTIFICATION",
"notifyLimitCount": 2,
"priority": "Low",
"recipients": [
{
"id": "USR0000000028",
"name": "AP_User",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
},
{
"id": "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name": "Cloud roster",
"type": "ROSTER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Ops group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"email": "opsuser@opsramp.com",
"firstName": "Ops",
"id": "USR0000000030",
"lastName": "User",
"loginName": "OpsAdmin",
"mobileNumber": "9876543210",
"phoneNumber": ""
},
"assigneeGroup": {
"description": "",
"id": 1,
"name": "Test Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"businessImpact": {
"description": "Impact level 2",
"name": "Impact 2",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"cc": "tester1@opsramp.com",
"customFields": [
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Test Cutom",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000002",
"mandatory": false,
"name": "test_cutom_2",
"value": "2"
},
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Esc custom field",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000004",
"mandatory": false,
"name": "esc_custom_field_4",
"value": "request custom field - text"
}
],
"priority": "Low",
"status": "New",
"toEmail": "tester2@opsramp.com",
"urgency": {
"description": "Urgency level 1",
"name": "Urgency 1",
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
}
},
"notifyIncident": "whenAlertStateChanged",
"updateIncident": {
"none": true,
"priorityRules": [
{
"businessImpact": {
"description": "Test",
"name": "Test Ops impact",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"description": "Test",
"name": "Test Ops urgency",
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
},
"value": "Warning"
}
]
},
"waitMins": 5
}
],
"filterCriteria": {
"matchingType": "ALL",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
},
{
"key": "Alert : Occurrence Frequency",
"operator": "GREATERTHANOREQUALTO",
"value": {
"frequency": "2",
"frequencyType": "hours",
"occurrences": "5"
}
},
{
"key": "Resource : Resource Type",
"operator": "MATCH",
"value": "DEVICE"
}
]
},
"id": "POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42",
"name": "Create escalate alert policy API",
"policyType": "ESCALATION_POLICY",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"name": "LPT00001",
"type": "RESOURCE"
},
{
"id": "7_AWS",
"name": "AWS",
"type": "LOCATION"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"name": "Test Group",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"name": "Test SG",
"type": "SERVICEGROUP"
},
{
"id": "client_6",
"name": "Ops Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 7,
"name": "Netenrich Client",
"uniqueId": "client_7"
},
"updatedBy": {
"email": "opsuser@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"updatedDate": "2017-05-15T10:35:51+0000"
}
{
"active": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "tester1@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"createdDate": "2017-05-15T10:35:51+0000",
"description": "Test description",
"enabledMode": "ON",
"escalationType": "AUTOMATIC_UNTIL_ACKNOWLEDGED_CLOSED_SUPPRESSED_TICKETED",
"escalations": [
{
"action": "NOTIFICATION",
"notifyLimitCount": 2,
"priority": "Low",
"recipients": [
{
"id": "USR0000000028",
"name": "AP_User",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
},
{
"id": "ES-de9bfd9f-d8ee-430f-4bc0-e6e4645cdb47",
"name": "Cloud roster",
"type": "ROSTER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Ops group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"email": "opsuser@opsramp.com",
"firstName": "Ops",
"id": "USR0000000030",
"lastName": "User",
"loginName": "OpsAdmin",
"mobileNumber": "9876543210",
"phoneNumber": ""
},
"assigneeGroup": {
"description": "",
"id": 1,
"name": "Test Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"businessImpact": {
"description": "Impact level 2",
"name": "Impact 2",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"cc": "tester1@opsramp.com",
"customFields": [
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Test Cutom",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000002",
"mandatory": false,
"name": "test_cutom_2",
"value": "2"
},
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Esc custom field",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000004",
"mandatory": false,
"name": "esc_custom_field_4",
"value": "request custom field - text"
}
],
"priority": "Low",
"status": "New",
"toEmail": "tester2@opsramp.com",
"urgency": {
"description": "Urgency level 1",
"name": "Urgency 1",
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
}
},
"notifyIncident": "whenAlertStateChanged",
"updateIncident": {
"none": true,
"priorityRules": [
{
"businessImpact": {
"description": "Test",
"name": "Test Ops impact",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"description": "Test",
"name": "Test Ops urgency",
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
},
"value": "Warning"
}
]
},
"waitMins": 5
}
],
"filterCriteria": {
"matchingType": "ALL",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": {
"type": "critical"
}
},
{
"key": "Alert : Occurrence Frequency",
"operator": "GREATERTHANOREQUALTO",
"value": {
"frequency": 2,
"frequencyType": "hours",
"occurrences": 5
}
},
{
"key": "Resource : Resource Type",
"operator": "MATCH",
"value": {
"type": "DEVICE"
}
}
]
},
"id": "POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42",
"name": "Create escalate alert policy API",
"policyType": "ESCALATION_POLICY",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"name": "LPT00001",
"type": "RESOURCE"
},
{
"id": "7_AWS",
"name": "AWS",
"type": "LOCATION"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"name": "Test Group",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"name": "Test SG",
"type": "SERVICEGROUP"
},
{
"id": "client_6",
"name": "Ops Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 7,
"name": "Netenrich Client",
"uniqueId": "client_7"
},
"updatedBy": {
"email": "tester1@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"updatedDate": "2017-05-15T10:35:51+0000"
}
{
"active": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "opsuser@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"createdDate": "2017-05-15T11:10:32+0000",
"description": "Test description",
"enabledMode": "ON",
"escalationType": "MANUAL",
"escalations": [
{
"action": "NOTIFICATION",
"recipients": [
{
"id": "USR0000000019",
"name": "mani_partner",
"type": "USER"
},
{
"id": "USRGRP-9498fc95-67b7-3477-953f-1ec70bf0c61d",
"name": "Cloud group",
"type": "USERGROUP"
},
{
"id": "ES-d16473ee-29de-1cf2-4983-86307733e34c",
"name": "Test roster",
"type": "ROSTER"
}
]
}
],
"filterCriteria": {
"matchingType": "ALL",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
}
]
},
"id": "POLICY-a204aea2-f943-46cb-86fa-86197e796f70",
"name": "Create escalate alert policy API for NOC123",
"policyType": "ESCALATION_POLICY",
"resources": [
{
"id": "bf3a10a2-92f1-4610-b3f4-174ed83db7b9",
"name": "LPT00001",
"type": "RESOURCE"
},
{
"id": "7_AWS",
"name": "AWS",
"type": "LOCATION"
},
{
"id": "DGP-0b165e70-7152-49f1-bfe3-ebe77409d5f2",
"name": "Test Group",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"name": "Test SG",
"type": "SERVICEGROUP"
},
{
"id": "client_6",
"name": "Ops Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 5,
"name": "Ops Partner",
"uniqueId": "msp_5"
},
"updatedBy": {
"email": "opsuser@opsramp.com",
"firstName": "Ops Admin",
"loginName": "ops_admin_user"
},
"updatedDate": "2017-05-15T11:10:32+0000"
}