Skip to main content
PATCH
Edit an alert rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

alert_id
string
required

Body

application/json

Body for editing an alert rule (the ten rule fields, all optional).

The write service validates the patch merged with the stored rule; an edit to any evaluated field resets the evaluation state (and clears an open page), which the response reports. Status has its own route.

project_id
string
required
aggregation
enum<string>
Available options:
sum,
avg,
count,
max,
min,
p50,
p75,
p90,
p95,
p99,
uniq
filters
AlertFilterItemRequest · object[]

Row predicates the measure is evaluated over

measure
string

A measure of the view, e.g. latency, cost, count

name
string
no_data_mode
enum<string>

What a window that measured nothing means

Available options:
HOLD,
ZERO,
NOTIFY
renotify
Renotify · object

How often an alert re-notifies while it stays in the alerting state.

threshold
number
threshold_operator
enum<string>
Available options:
>,
>=,
<,
<=,
=,
!=
view
string
Allowed value: "SPANS"
window
enum<string>
Available options:
1m,
5m,
10m,
30m,
1h,
2h

Response

Successful Response

The updated alert with its full rule, plus what the edit did to its state.

alert
AlertDetail · object
required

One alert with its full rule: the summary plus filters and gap handling.

changed
string[]
required
updated
boolean
required
page_cleared
boolean
default:false

True when the alert was firing and the edit discarded that page

state_reset
boolean
default:false

True when the edit voided the evaluation state and made the rule due now (any evaluated field changed, or the alert was resumed)