REST API Developer's Guide

About the Alerts Resource

You can use LogicMonitor's REST API to programmatically get and acknowledge your alerts.

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

 

Resource Properties

All alerts have the following properties:

Property

Description

Type

id The alert id String
type The type of alert String
internalId The internal id for the alert String
startEpoch The time (in epoch format) that the alert started Integer
endEpoch The time (in epoch format) that the alert ended Integer
acked Whether or not the alert has been acknowledged Boolean
ackedEpoch The time (in epoch format) that the alert was acknowledged Integer
ackedBy The user that acknowledged the alert String
ackComment The comment submitted with the acknowledgement String
rule The rule the alert matches String
ruleId The id of the rule the alert matches Integer
chain The escalation chain the alert was routed to String
chainId The id of the escalation chain the alert was routed to Integer
nextRecipient The next recipient in the escalation chain for this alert. Integer
receivedList The recipients that have received the alert JSON object
severity The alert severity, where 2=warning, 3=error and 4=critical String
cleared Whether or not the alert has cleared Boolean
sdted Whether or not the alert was triggered during an SDT Boolean
SDT The active SDT, if one exists String
alertValue The value that triggered the alert JSON Object
threshold The threshold associated with the object in alert String
clearValue The value that cleared the alert String
monitorObjectId The id of the object that the alert is associated with Integer
monitorObjectName The name of the object that the alert is associated with String
monitorObjectGroups Information about the groups the object is a member of JSON Object
resourceTemplateId The id of the datasource in alert Integer
resourceTemplateName The name of the datasource in alert String
instanceId The id of the instance in alert Integer
instanceName The name of the instance in alert String
instanceDescription The description of the instance in alert String
dataPointName The name of the datapoint in alert String
detailMessage The alert message, if needMessage=true is included in the query parameters JSON Object