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

NameTypeRequiredDescription
idstringIdentifier of the rule to change
namestringNew name for the rule
enabledbooleanfalse stops evaluation and keeps the rule
conditionobjectThe kind’s parameters
throttleMinutesintegerNew quiet period after a firing, in minutes

Response

FieldTypeAlwaysDescription
idstringIdentifier of the rule
kindstringWhat the rule measures
namestringHuman name the rule was registered under
statestringfiring means the condition is met right now
enabledbooleanWhether the evaluator measures it every minute
conditionobjectThe kind’s parameters: threshold and window, plus q for log_match
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 timestamp of the last change
lastFiredAtstringISO 8601 time it last fired, or null
throttleMinutesnumberHow 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.

navigateselect