Updating Escalation Chain Details

Last updated on 03 January, 2024

You can use LogicMonitor REST API v3 to update escalation chain details. You must authenticate yourself before making the API request.

URI: PATCH /setting/alert/chains/{id}

URI: PUT /setting/alert/chains/{id}

Note: As per the REST standards, a property that is not specified in a PUT request will revert to its default value.

idInteger(Mandatory) The ID of the escalation chain that you want to update. You can get the ID via a GET request to the escalation chains resource.
throttlingAlertsIntegerIf enableThrottling is set to true, then throttlingAlerts indicates the maximum number of alerts that can be send during the throttling period.
Example – “throttlingAlerts”: 35
enableThrottlingBooleanIndicates whether or not throttling (rate limiting) is enabled for this escalation chain. If the field is set to true, then throttlingPeriod and throttlingAlerts indicate how alerts are throttled.
Example – “enableThrottling”: false
destinations(Mandatory) The destination consists of the following:
  • period – the list of week day of this period (weekDays), the timezone for this period (timezone), the start and end minute of this period (startMinutes and endMinutes).
  • stages – It consists of typemethodcontact, and addr. See the description of the ccDestinations field.
  • type – It indicates the type of stages in this chain. The values can be timebased or simple 
nameString(Mandatory) The name of the escalation chain.
Example – “name”: ”MyEscalationChain”
descriptionStringThe description of the escalation chain.
Example – "description": "For alerts escalated to the NOC Team."
ccDestinationsThe ccDestination consists of the recipient’s details:
  • type – (Mandatory) Supported recipient types are GROUPARBITRARY, and ADMIN. Here, ADMIN indicates a user and ARBITRARY indicates an arbitrary email.
  • method – (Mandatory) Supported methods are EMAILsmsEMAILVOICE, and SMS. The method varies as per the recipient type.
    ARBITRARY – Use email
    ADMIN – Use EMAILsmsEMAILVOICESMS. If a method is not provided, then the default method EMAIL is used.
    GROUP – Does not require a method
  • contact – It includes the email address or phone number of the recipients.
  • addr – If the type is Admin provide the username, and if the type is Arbitrary provide the email address of the recipients.
throttlingPeriodIntegerThe throttling (rate limit) period in minutes if enableThrottling is set to true.
Example – “throttlingPeriod”: 20