Skip to main content
GET
List alerts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

The page to return.

Required range: x >= 1
page_size
integer
default:20

Alerts per page.

Required range: 1 <= x <= 100

Only alerts whose name matches this text. The name parameter is accepted as an alias.

enabled
boolean

Only enabled alerts (true) or only muted ones (false).

severity
string

Only alerts with a rule of this severity.

resource_type
string

Only alerts with a rule on this resource type.

cluster_id
string<uuid>

Only alerts whose rules watch this cluster.

sort_by
enum<string>

The column to sort on; an unknown column falls back to newest first.

Available options:
id,
name,
enabled,
firing,
status,
severity,
state,
rule_count,
created_at,
updated_at
sort_order
enum<string>
default:asc

The sort direction; applies only with sort_by.

Available options:
asc,
desc

Response

One page of alerts with the organisation's totals

items
object[]
required
pagination
object
required
metrics
object
required