List alert rules

GET

/api/v1/alerts/rules

curl --request GET \
  --url https://example.com/api/v1/alerts/rules \
  --header 'Authorization: <Authorization>'

Returns alert rule rows, optionally filtered by environment.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

env

integer

Environment ID; omit to list all

Responses

200

OK

Media typeapplication/json

Array<object>

object

channel_ids

Array<integer>

cooldown_minutes

integer

created_at

string

enabled

boolean

environment_id

integer

id

integer

info

string

match_field

string

match_type

string

match_value

string

name

string

node_uuid

string

source

string

status_severity

string

updated_at

string

Example^generated

[
  {
    "channel_ids": [
      1
    ],
    "cooldown_minutes": 1,
    "created_at": "example",
    "enabled": true,
    "environment_id": 1,
    "id": 1,
    "info": "example",
    "match_field": "example",
    "match_type": "example",
    "match_value": "example",
    "name": "example",
    "node_uuid": "example",
    "source": "example",
    "status_severity": "example",
    "updated_at": "example"
  }
]

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Alerts disabled

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}