Skip to main content
PATCH
Update a metric alarm

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
alarm_id
string
required

Body

application/json

Body for PATCH /orgs/{org_id}/alarms/{alarm_id} — all fields optional.

clear_threshold
number<double> | null

Double-option so null clears the hysteresis and an absent key leaves it alone — a plain Option can't tell those apart.

comparison
null | enum<string>
Available options:
gt,
gte,
lt,
lte
datapoints_to_alarm
integer<int32> | null
enabled
boolean | null
evaluation_periods
integer<int32> | null
min_sample_count
integer<int64> | null
missing_data
null | enum<string>
Available options:
not_breaching,
breaching,
insufficient,
ignore
name
string | null
period_seconds
integer<int32> | null
stat
null | string

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.

Pattern: ^(avg|sum|count|min|max|p\d+(\.\d+)?)$
Example:

"p99"

threshold
number<double> | null

Response

Alarm updated