Endpoint
/api/v2/tenants/{tenantId}/escalations/{id}
Path Parameters
tenantIdstring
idstring
Responses
OK
Endpoint
/api/v2/tenants/{tenantId}/escalations/{id}
Path Parameters
tenantIdstring
idstring
Query Parameters
scopestring
Users, User Groups, and Rosters to receive the escalations.
rostersstring
Roster is a list of users part of the schedule doing particular duty.
escalationTypestring
Escalation rules are actions taken when an alert is not acknowledged within the desired time.OpsRamp supports manual and automatic escalation types.
actionstring
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.
escalationsstring
Information about the escalation actions.
waitMinsstring
The time interval to escalate an alert after generation. Escalate after the alert has elapsed the set time.
notifyLimitCountstring
A threshold limit on the number of notifications a user receives. Example: notifyLimitCount: 5
alertStateTransitionFromstring
For every change in the alert state, user receives notifications.
recipientsstring
- For escalationType: MANUAL- Users to contact directly. User ID (or) name. - For escalationType: AUTOMATIC- Recipients who receives notifications.
allClientsstring
This string helps to differentiate between partner and client escalation policies. allClients: true indicates the policy is a partner level policy.
machineLearningstring
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. - learnedFieldsToOutputColumnsMap"Assignee Group": "incident.assigneeGroup","Priority": "incident.priority"
repeatFrequencystring
The time interval when a user receives repeated notifications. This example indicates that a user receives repeated notifications every 15 minutes: repeatFrequency: 15.
Responses
OK
activeboolean
allClientsboolean
clientMatchingTypestring
createdByobject
Child Parameters
- createdBy.email
- createdBy.firstName
- createdBy.lastName
- createdBy.loginName
createdDatestring
descriptionstring
escalationTypestring
escalationsarray
Child Parameters
- escalations.action
- escalations.incident
- escalations.notifyIncident
- escalations.notifyLimitCount
- escalations.priority
- escalations.recipients
- escalations.repeatFrequency
- escalations.updateIncident
- escalations.waitMins
idstring
namestring
policyTypestring
resourcesarray
Child Parameters
- resources.aliasName
- resources.hostName
- resources.id
- resources.name
- resources.resourceType
- resources.type
updatedByobject
Child Parameters
- updatedBy.email
- updatedBy.firstName
- updatedBy.lastName
- updatedBy.loginName
updatedDatestring
{
"active": true,
"allClients": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"createdDate": "2017-05-15T12:13:31+0000",
"description": "",
"escalationType": "AUTOMATIC",
"escalations": [
{
"action": "NOTIFICATION",
"notifyLimitCount": 2,
"priority": "High",
"recipients": [
{
"id": "ES-d16473ee-29de-1cf2-4983-86307733e34c",
"name": "Support Team",
"type": "ROSTER"
},
{
"id": "USR0000000019",
"name": "Jim Bolt",
"type": "USER"
}
],
"repeatFrequency": 10,
"waitMins": 0
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"email": "james.hudson@myorganization.com",
"firstName": "James",
"lastName": "Hudson",
"loginName": "James.Hudson",
"mobileNumber": "802-123-4123",
"phoneNumber": ""
},
"businessImpact": {
"description": "SP Level Impact",
"name": "Impact 3",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"customFields": [
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "Default Component",
"description": "",
"displayLabel": "Component",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000002",
"mandatory": false,
"name": "test_cutom_2",
"value": "Test1"
}
],
"machineLearning": {
"continuousLearning": false,
"learnedFieldsToOutputColumnsMap": {
"Assignee Group": "incident.assigneeGroup",
"Priority": "incident.priority"
}
},
"priority": "Low",
"status": "New",
"toEmail": "support@myorganization",
"urgency": {
"description": "SP Level Urgency",
"name": "Urgency 3",
"uniqueId": "SURG-09358506-4af1-4d35-b902-cd3b14a00c10"
}
},
"notifyIncident": "forEveryUpdate",
"updateIncident": {
"none": true,
"priorityRules": [
{
"businessImpact": {
"description": "",
"name": "Test Ops impact",
"uniqueId": "SIMPACT-d8853b21-ebc5-dd1d-d9a3-7a7b121ae0e"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"description": "",
"name": "Test Ops urgency",
"uniqueId": "SURG-59358506-4bf1-4d35-c902-de3b14a00c10"
},
"value": "Warning"
}
]
},
"waitMins": 5
}
],
"filterCriteria": {
"matchingType": "ALL",
"rules": [
{
"key": "Alert : Description",
"operator": "CONTAINS",
"value": "critical"
}
]
},
"id": "POLICY-9d6bbe58-2bf6-41cc-9983-fca53b64c9e7",
"name": "Cloud Instance Alerts Policy",
"policyType": "ESCALATION_POLICY",
"resources": [
{
"aliasName": "",
"hostName": "Device11",
"id": "7447fef1-68ee-4c2a-a366-273abc819dbc",
"name": "ESC00002",
"resourceName": "",
"resourceType": "RESOURCE",
"type": "RESOURCE"
},
{
"aliasName": "",
"hostName": "Device12",
"id": "59d820d3-7a64-4329-ba9c-bb9c14a4815c",
"name": "Device12",
"resourceName": "",
"resourceType": "RESOURCE",
"type": "RESOURCE"
}
],
"scope": {
"activated": true,
"name": "Luminalto",
"uniqueId": "msp_5"
},
"updatedBy": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"updatedDate": "2017-05-15T12:13:31+0000"
}
Endpoint
/api/v2/tenants/{tenantId}/escalations/{id}
When the escalation action is set to INCIDENT, an incident is automatically created from the alert and assigned to the desired user/team.
- Create New Incident
- Update Incident
No further level of escalation can be added as the escalation ends when an incident is created from the alert.
Path Parameters
tenantIdstring
idstring
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
(Optional) Escalation policy name.
resourcesarray
(Optional) Resources on which the policy would be applied. 1. Resource ID 2. Resource type Example: DEVICE,Use the following APIs to fetch the resource types: 1. DEVICE: Search Devices or Get Minimal Details of Resources API to fetch the list of devices or resources in a client. 2. DEVICEGROUP: Get Child Device Groups and Get Root Level Device Groups to fetch the list of device groups. 3. SERVICEGROUP: Get Service Groups to fetch the list of service groups. 4. LOCATION: Search Sites to fetch the list of sites. 5. CLIENT: Search Clients to fetch the list of clients. Only partner users have permission to fetch the details of client.
Child Parameters
- resources.id
- resources.type
{
"description": "Issues in network devices.",
"escalationType": "AUTOMATIC",
"escalations": [
{
"action": "NOTIFICATION",
"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": "OpsRamp group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"id": "USR0000000030",
"loginName": "Ops_User"
},
"assigneeGroup": {
"name": "Network Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"cc": "support@domain.com",
"customFields": [
{
"id": "UDF0000000002",
"name": "Number of attached incidents",
"value": "2"
},
{
"id": "UDF0000000004",
"name": "esc_custom_field_4",
"value": "$function.substring($alert.description ,'SITE ID=','\n')"
}
],
"priority": "Very Low",
"toEmail": "james.scott@domain.co"
},
"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": "days",
"occurrences": "5"
}
}
]
},
"name": "Network Devices Down",
"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"
}
]
}
{
"active": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"createdDate": "2017-05-15T11:10:32+0000",
"description": "Issues in network devices.",
"escalationType": "MANUAL",
"escalations": [
{
"action": "NOTIFICATION",
"recipients": [
{
"id": "USR0000000019",
"name": "Partner.A",
"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": "Network Devices Down",
"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": "Network Group",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"name": "Network Service Group",
"type": "SERVICEGROUP"
},
{
"id": "client_6",
"name": "OpsRamp Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 5,
"name": "OpsRamp Partner",
"uniqueId": "msp_5"
},
"updatedBy": {
"email": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"updatedDate": "2017-05-15T11:10:32+0000"
}
Responses
OK
activeboolean
clientMatchingTypestring
createdByobject
Child Parameters
- createdBy.email
- createdBy.firstName
- createdBy.lastName
- createdBy.loginName
createdDatestring
descriptionstring
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": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"createdDate": "2017-05-15T10:35:51+0000",
"description": "Issue in Network devices.",
"escalationType": "AUTOMATIC",
"escalations": [
{
"action": "NOTIFICATION",
"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": "OpsRamp group",
"type": "USERGROUP_DL"
}
],
"repeatFrequency": 5,
"waitMins": 5
},
{
"action": "INCIDENT",
"incident": {
"assignedUser": {
"email": "James.Rivers@domain.com",
"firstName": "James",
"id": "USR0000000030",
"lastName": "Rivers",
"loginName": "James.Rivers",
"mobileNumber": "406-559-1234",
"phoneNumber": ""
},
"assigneeGroup": {
"description": "",
"id": 1,
"name": "Network Group",
"uniqueId": "USRGRP-4189ae2e-bcf5-f686-26d0-8b6eabd91558"
},
"cc": "support@domain.com",
"customFields": [
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Number of attached incidents",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000002",
"mandatory": false,
"name": "Attached Incidents",
"value": "2"
},
{
"classCode": "INCIDENT",
"customField": true,
"defaultValue": "",
"description": "",
"displayLabel": "Incident History",
"editable": true,
"fieldType": "TYPE_TEXT",
"id": "UDF0000000004",
"mandatory": false,
"name": "Incident History",
"value": "request custom field - text"
}
],
"priority": "Low",
"status": "New",
"toEmail": "james.scott@domain.com"
},
"notifyIncident": "whenAlertStateChanged",
"updateIncident": {
"none": true,
"priorityRules": [
{
"businessImpact": {
"description": "The issue may cause fluctuations in network.",
"name": "High Level Impact",
"uniqueId": "SIMPACT-e8853b21-ebc5-dd1d-d9a3-7a7b121a5e0f"
},
"key": "currentState.code",
"operator": "Is",
"priority": "High",
"urgency": {
"description": "Need to fix within 2 hours.",
"name": "High",
"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": "days",
"occurrences": "5"
}
}
]
},
"id": "POLICY-e29f63f3-951a-4b41-a2a9-94835f6e9a42",
"name": "Network Devices Down",
"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": "OpsRamp Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 7,
"name": "AB Client",
"uniqueId": "client_7"
},
"updatedBy": {
"email": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "vJohn.Smith"
},
"updatedDate": "2017-05-15T10:35:51+0000"
}
{
"active": true,
"clientMatchingType": "ALL",
"createdBy": {
"email": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"createdDate": "2017-05-15T11:10:32+0000",
"description": "Issues in network devices.",
"escalationType": "MANUAL",
"escalations": [
{
"action": "NOTIFICATION",
"recipients": [
{
"id": "USR0000000019",
"name": "Partner.A",
"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": "Network Devices Down",
"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": "Network Group",
"type": "DEVICEGROUP"
},
{
"id": "SGP-11f1a6a8-acc8-411f-86c1-b693dd8e9817",
"name": "Network Service Group",
"type": "SERVICEGROUP"
},
{
"id": "client_6",
"name": "OpsRamp Client",
"type": "CLIENT"
}
],
"scope": {
"activated": true,
"id": 5,
"name": "OpsRamp Partner",
"uniqueId": "msp_5"
},
"updatedBy": {
"email": "john.smith@domain.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "John.Smith"
},
"updatedDate": "2017-05-15T11:10:32+0000"
}