Skip to main content
POST
List Alerts

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
include_total
boolean
default:false

Body

application/json

Request model to list alerts.

search
string | null

Search term for wildcard search across alert_id, name, description

filters
LogicalOperator · object | null

Filters to apply to the alert list

sort
SortOption · object | null

Sort configuration for the alert list

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response model for listing alerts.

results
AlertResponse · object[]
required

List of alerts

pagination
PaginationResponse · object
required

Pagination information

total_count
integer
required

Total number of alerts matching query

stats
AlertListStats · object | null

Aggregate statistics across all alerts in the result