Skip to content

observe_alerts_get

Read one alert rule of this product, with its current state and last firing.

Tool

observe_alerts_get

Read one alert rule of this product, with its current state and last firing.

Read one alert rule of this product, with its current state and last firing.

Behavior

HTTP
GET /observe/alerts/:id

Arguments

NameTypeRequiredDescription
idstringIdentifier of the rule

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

Read one alert rule of this product, with its current state and last firing.

When to use

Read one alert rule of this product, with its current state and last firing.

Example

Ask your agent something like this:

Read one alert rule of this product, with its current state and last firing.

The agent will invoke observe_alerts_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect