RPC API Developer's Guide

Get an Escalation Chain

Note that LogicMonitor has a REST API equivalent for this function.

Escalation Chains define the set of users who are notified at each stage of an alert's lifecycle.  An Escalation Chain consists of destination stages.  When an alert is routed to an escalation chain (via a matching alert rule) notifications are sent to the stages defined in the Escalation Chain. You can use the getEscalatingChain RPC to view details for existing escalation chains programmatically.

Note: As with all our API calls, authentication is required.

 

getEscalatingChains

Get a list of Escalation Chains

URL:

https://accountName.logicmonitor.com/santaba/rpc/getEscalatingChains?c=accountName&u=user&p=password
 

All outputs will be in the format: { [status], [data], [errmsg] }, where status is the status of the response, errmsg is the error message associated with the response, and the data object includes the following for each Escalation Chain:

Value

Description

id The id of the escalation chain
throttlingPeriod The time period for throttling alerts
throttlingAlerts The max number of alerts that will be sent in the throttlingPeriod
description The long text description
ccdestination The JSON string representing the cc recipients set for the escalation chain
name The name of the added escalation chain
enableThrottling The current state of alert throttling
inAlerting The current state of alerting on the escalation chain.
destination JSON string representing the set of stages including recipients

Example

Request:

curl "https://apiAccount.logicmonitor.com/santaba/rpc/getEscalatingChains?c=apiAccount&u=apiUser&p=example" 
Response:

{
  "status": 200,
  "data": [
    {
      "id": 12,
      "throttlingPeriod": 10,
      "throttlingAlerts": 20,
      "description": "",
      "ccdestination": [],
      "name": "DBAdmin",
      "enableThrottling": true,
      "inAlerting": false,
      "destination": [{
        "type": "simple",
        "stages": [
          [
            {
              "addr": "Victoria",
              "method": "email",
              "comment": "",
              "type": "admin"
            },
            {
              "addr": "Victoria",
              "method": "Ticketing",
              "comment": "",
              "type": "admin"
            },
            {
              "addr": "Victoria",
              "method": "Hipchat_Critical",
              "comment": "",
              "type": "admin"
            }
          ],
          [
            {
              "addr": "Management",
              "method": "email",
              "comment": "",
              "type": "admin"
            },
            {
              "addr": "Victoria",
              "method": "email",
              "comment": "",
              "type": "admin"
            }
          ],
          []
        ]
      }]
    },.......
    .........
    .........
{
      "id": 11,
      "throttlingPeriod": 10,
      "throttlingAlerts": 20,
      "description": "",
      "ccdestination": [],
      "name": "Ticketing",
      "enableThrottling": true,
      "inAlerting": false,
      "destination": [{
        "type": "simple",
        "stages": [[{
          "addr": "sarah",
          "method": "Ticketing",
          "comment": "",
          "type": "admin"
        }]]
      }]
    }
  ],
  "errmsg": "OK"
}