Skip to content

observe_alerts_update

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled.

Tool

observe_alerts_update

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled.

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled. What the rule measures — its kind — is not editable; create a second rule instead. Omit a field to leave it alone.

Behavior

HTTP
PATCH /observe/alerts/:id

Arguments

Name
Type
Required
Description
id
string
•
Identifier of the rule to change
name
string
—
New name for the rule
enabled
boolean
—
false stops evaluation and keeps the rule
condition
object
—
The kind’s parameters
throttleMinutes
integer
—
New quiet period after a firing, in minutes

Response

Field
Type
Always
Description
id
string
•
Identifier of the rule
kind
string
•
What the rule measures
name
string
•
Human name the rule was registered under
state
string
•
firing means the condition is met right now
enabled
boolean
•
Whether the evaluator measures it every minute
condition
object
•
The kind’s parameters: threshold and window, plus q for log_match
createdAt
string
•
ISO 8601 creation timestamp
updatedAt
string
•
ISO 8601 timestamp of the last change
lastFiredAt
string
•
ISO 8601 time it last fired, or null
throttleMinutes
number
•
How long after firing the rule stays quiet

Try it

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled.

When to use

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled. What the rule measures — its kind — is not editable; create a second rule instead. Omit a field to leave it alone.

Example

Ask your agent something like this:

Edit an alert rule: its name, its condition, its throttle, or whether it is enabled.

The agent will invoke observe_alerts_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select