Update Alarm
Alarms
Update Alarm
Update an alarm configuration.
PATCH
Update Alarm
Headers
string
required
Your API key for authentication.
Path Parameters
string
required
Alarm configuration ID.
Body Parameters
number
Updated positive numeric threshold.Notes:
thresholdis a sensitivity scalar (higher values are less sensitive; lower values are more sensitive).- The Dashboard may display an approximate ”% change” visualization for this value. Treat that UI percentage as a directional aid, not an exact conversion.
Sensitive→0.5Normal→1.0Relaxed→2.0Critical→2.5
boolean
Controls whether this alarm is actively evaluated.
true: Alarm is active. The system will evaluate this metric on scheduled runs and can generate alarm/recovery events and notifications.false: Alarm is paused. The config is retained, but scheduled evaluation and notifications for this alarm are disabled until re-enabled.
object|null
Updated webhook settings. Set to
null to clear.webhook_config should be a JSON object with:url(string, required when object is provided)headers(object, optional)
string[]
Updated email recipients.
string[]
Updated SMS recipients.
Response
object
Updated alarm configuration object.
object|null
Updated webhook settings object. Header values may be masked in API responses.
string[]
Updated email recipients. Can be an empty array if none are configured.
string[]
Updated SMS recipients. Can be an empty array if none are configured.
null|array
null on success, otherwise an array of error objects.Docs for agents: llms.txt