Skip to main content
POST
Toggle Alarm

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
Alarm configuration ID.

Body Parameters

boolean
required
  • 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.

Response

object
Updated alarm configuration object.
boolean
Updated enabled state.
string
Alarm configuration ID.
string
Metric this alarm tracks.
number
Configured threshold for this alarm.
object|null
Webhook settings object. Header values may be masked in responses.
string[]
Email recipients for notifications. Can be an empty array.
string[]
SMS recipients for notifications. Can be an empty array.
string
ISO timestamp when the alarm was created.
string
ISO timestamp when the alarm was last updated.
null|array
null on success, otherwise an array of error objects.

Docs for agents: llms.txt