alarms

Get a metric alarm

Changed on

One alarm's configuration, current state and linked channels.

Same shape as an entry in GET /orgs/{org_id}/alarms, for refreshing a detail view without refetching the whole list.

Needs alarms.read for an org-level alarm, or projects.alarms.read on the owning project for a project alarm.

get/orgs/{org_id}/alarms/{alarm_id}

Request

  • Base URL
    https://api.timbal.ai
  • URL
    https://api.timbal.ai/orgs/{org_id}/alarms/{alarm_id}
  • Auth
    HTTP bearer

Path parameters

org_idstring required
alarm_idstring required

Response

The alarm

clear_thresholdnumber double nullable

Set when this alarm uses hysteresis; see [CreateAlarmReq].

comparison'gt' | 'gte' | 'lt' | 'lte' required
datapoints_to_alarminteger required
denominator_metric_namestring nullable

Set when this is a ratio alarm; see [CreateAlarmReq].

enabledboolean required
evaluation_periodsinteger required
idinteger required
metric_namestring required
min_sample_countinteger required
missing_data'not_breaching' | 'breaching' | 'insufficient' | 'ignore' required
namestring required
period_secondsinteger required
project_idinteger nullable

Project this alarm belongs to; omitted for org-level alarms.

statstring required

Aggregation applied to each evaluation period. Percentiles run from p0.1 to p99.9 in tenths; equivalent spellings such as p95.0 are accepted and returned canonically as p95, while a finer value such as p95.05 is rejected rather than rounded. They are exact rather than interpolated from bins, so they are only available on app.run.duration_ms and cannot be used with denominator_metric_name.

state'ok' | 'alarm' | 'insufficient_data' required
state_changed_atstring date-time nullable
thresholdnumber double required

Example response

{
  "stat": "p99"
}

Changes