List configured alert rules

View as MarkdownOpen in Claude

Returns the alert rules configured for the operator’s organisation. Filter by event type, active state, or delivery channel; use the catalog endpoint to discover what event types are available.

Authentication

AuthorizationBearer

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

Query parameters

cursorstringOptional
Opaque cursor returned from a prior call.
limitdoubleOptional1-100
Maximum number of results to return. Defaults to 20.
sortBystringOptional
Sort field.
sortOrderenumOptional
Sort order.
Allowed values:
eventTypestringOptional
Filter by alert event type code.
isActivebooleanOptional
Filter by active state. Set false to view paused rules.
channelenumOptional
Filter by delivery channel.
Allowed values:

Response

A cursor-paginated page of alert rules.

datalist of objects
Alert rules for this page.
paginationobject
Cursor metadata for paging forward.