Endpoint
/api/v2/tenants/{tenantId}/escalations
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

active
boolean

allClients
boolean

createdBy
object

createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.userPreferences
createdDate
string

description
string

enabledMode
string

escalationType
string

escalations
array

escalations.action
escalations.alertStateTransitionFrom
escalations.incident
escalations.notifyIncident
escalations.notifyLimitCount
escalations.priority
escalations.recipients
escalations.repeatFrequency
escalations.updateIncident
escalations.waitMins
filterCriteria
object

filterCriteria.matchingType
filterCriteria.rules
id
string

name
string

policyType
string

resources
array

resources.aliasName
resources.hostName
resources.id
resources.name
resources.resourceType
resources.type
updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.id
updatedBy.lastName
updatedBy.loginName
updatedBy.userPreferences
updatedDate
string

{
  "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

active
boolean

allClients
boolean

clientMatchingType
string

createdBy
object

createdBy.email
createdBy.firstName
createdBy.id
createdBy.lastName
createdBy.loginName
createdBy.userPreferences
createdDate
string

description
string

enabledMode
string

escalationType
string

escalations
array

escalations.action
escalations.alertStateTransitionFrom
escalations.incident
escalations.notifyIncident
escalations.notifyLimitCount
escalations.priority
escalations.recipients
escalations.repeatFrequency
escalations.updateIncident
escalations.waitMins
filterCriteria
object

filterCriteria.matchingType
filterCriteria.rules
id
string

name
string

policyType
string

resources
array

resources.aliasName
resources.hostName
resources.id
resources.name
resources.resourceType
resources.type
scope
object

scope.activated
scope.id
scope.isClient
scope.isMSP
scope.isServiceProvider
scope.isSolutionProvider
scope.name
scope.uniqueId
updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.id
updatedBy.lastName
updatedBy.loginName
updatedBy.userPreferences
updatedDate
string

{
  "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"
}