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

Name
Type
Required
Description
id
string
•
Identifier of the rule

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

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.

↑↓navigate↵select