Skip to main content
GET
List Alarms

Headers

authorization
string
required
Your API key for authentication.

Query Parameters

metric_type
string
Optional metric filter. Allowed values: latency, api_errors, call_length.

Response

data.alarms
array
Alarm configuration objects for your organization.
data.alarms[].id
string
Alarm configuration ID.
data.alarms[].metric_type
string
Metric this alarm tracks. One of: latency, api_errors, call_length.
data.alarms[].threshold
number
Trigger threshold for this metric.
data.alarms[].enabled
boolean
Whether this alarm is enabled.
data.alarms[].webhook_config
object|null
Webhook settings object, including url and optional masked headers.
data.alarms[].email_addresses
string[]
Email recipients for notifications.
data.alarms[].sms_numbers
string[]
SMS recipients for notifications.
data.alarms[].created_at
string
ISO timestamp for when the alarm was created.
data.alarms[].updated_at
string
ISO timestamp for when the alarm was last updated.
errors
null|array
null on success, otherwise an array of error objects.

Docs for agents: llms.txt