v4

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-056932.6 KB

Update alarm

put/v2/Alarms/{Sid}

Path parameters

Sidstring required

Sid

Request body

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

Webhook notification to send

consoleIndicatorboolean

Whether to send console notifications

descriptionstring required

Description for the alarm.

enabledboolean required

Is alarm enbled? Default is true.

Response

Ok

sidstring