Get alarm
get/v2/Alarms/{Sid}
Path parameters
Sidstring required
Sid
Response
Ok
friendlyNamestring required
Friendly name for alarm
queryType'ERROR_CODE' | 'LOG_LEVEL' | 'ALL' required
Type of query
querystring
Value to query for
triggerValueinteger required
Threshold to send customer alarm notification
timeWindow'FIVE_MINS' | 'FIFTEEN_MINS' | 'ONE_HOUR' | 'TWELVE_HOURS' | 'ONE_DAY' required
Time window for alarm to trigger
emailstring[]
Email notifications to send
webhookstring uri
Webhook notification to send
consoleIndicatorboolean
Whether to send console notifications
descriptionstring required
Description for the alarm.
enabledboolean required
Is alarm enbled? Default is true.
productstring required
Product the alarm is related to.
alertConfigSidstring required
Sid for the alarm
dateUpdatedstring date-time required
The date and time in UTC when the alarm was last updated specified in ISO 8601 format
dateCreatedstring date-time required
The date and time in UTC when the alarm was created specified in ISO 8601 format.