Update an alert

Update an alert.

Authentication

AuthorizationBearer

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

Path parameters

organizationIdstringRequired
The ID of the Organization to which the alert belongs to.
alertIdstringRequired
The ID of the alert to update.

Request

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

Response

OK
createdAtdatetime

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.
entityType"DEPLOYMENT"
The type of entity the alert is associated with.
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.
typeenum
The alert's type.
updatedAtdatetime

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

400
Update Alert Body Bad Request Error
401
Update Alert Body Unauthorized Error
403
Update Alert Body Forbidden Error
404
Update Alert Body Not Found Error
500
Update Alert Body Internal Server Error