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.

Path Parameters

organizationId
string
required

The ID of the Organization to which the alerts belong to.

Query Parameters

alertIds
string[]

A list of IDs for specific alerts to list. The API returns details for all alerts which have been specified in this list.

deploymentIds
string[]

A list of deployment IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Deployments.

workspaceIds
string[]

A list of workspace IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Workspaces.

alertTypes
enum<string>[]

A list of types for specific alerts to filter by. The API returns details for all alerts belonging only to the specified alert types.

Available options:
DAG_SUCCESS,
DAG_FAILURE,
DAG_DURATION,
DAG_TIMELINESS,
TASK_DURATION,
TASK_FAILURE
entityType
enum<string>

The type of the entity the alerts belong to.

Available options:
DEPLOYMENT
offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000
sorts
enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:
name:asc,
name:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

alerts
object[]
required

The list of alerts.

limit
integer
required

The limit for pagination.

offset
integer
required

The offset for pagination.

totalCount
integer
required

The total count of alerts.