Create an alert

Create an alert.

Path parameters

organizationIdstringRequired
The ID of the Organization to which the alert will belong to.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
Create Dag Duration Alert RequestobjectRequired
OR
Create Dag Failure Alert RequestobjectRequired
OR
Create Dag Success Alert RequestobjectRequired
OR
Create Dag Timeliness Alert RequestobjectRequired
OR
Create Task Duration Alert RequestobjectRequired
OR
Create Task Failure Alert RequestobjectRequired

Response

OK
createdAtstring

The time when the alert was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject
entityIdstring
The ID of the entity the alert is associated with.
entityTypeenum
The type of entity the alert is associated with.
Allowed values:
idstring
The alert's ID.
namestring
The alert's name.
organizationIdstring
The ID of the organization the alert is associated with.
rulesobject
severityenum
The alert's severity.
Allowed values:
typeenum
The alert's type.
updatedAtstring

The time when the alert was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject
deploymentIdstringOptional
The ID of the deployment the alert is associated with.
entityNamestringOptional
The name of the entity the alert is associated with.
notificationChannelslist of objectsOptional
The notification channels to send alerts to.
workspaceIdstringOptional
The ID of the workspace the alert is associated with.

Errors