Get an alert

1 curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts/alertId \ 2 -H "Authorization: Bearer <token>"

1 { 2 "createdAt": "createdAt", 3 "createdBy": { 4 "apiTokenName": "my-token", 5 "avatarUrl": "https://avatar.url", 6 "fullName": "Jane Doe", 7 "id": "clm8qv74h000008mlf08scq7k", 8 "subjectType": "USER", 9 "username": "user1@company.com" 10 }, 11 "deploymentId": "deploymentId", 12 "entityId": "entityId", 13 "entityName": "entityName", 14 "entityType": "DEPLOYMENT", 15 "id": "id", 16 "name": "name", 17 "notificationChannels": [ 18 { 19 "createdAt": "createdAt", 20 "deploymentId": "deploymentId", 21 "entityId": "entityId", 22 "entityType": "ORGANIZATION", 23 "id": "id", 24 "name": "name", 25 "organizationId": "organizationId", 26 "type": "SLACK", 27 "updatedAt": "updatedAt", 28 "workspaceId": "workspaceId" 29 } 30 ], 31 "organizationId": "organizationId", 32 "rules": { 33 "patternMatches": [ 34 { 35 "entityType": "DAG_ID TASK_ID", 36 "operatorType": "IS IS_NOT INCLUDES EXCLUDES", 37 "values": [ 38 "values" 39 ] 40 } 41 ] 42 }, 43 "severity": "INFO", 44 "type": "DAG_SUCCESS", 45 "updatedAt": "updatedAt", 46 "updatedBy": { 47 "apiTokenName": "my-token", 48 "avatarUrl": "https://avatar.url", 49 "fullName": "Jane Doe", 50 "id": "clm8qv74h000008mlf08scq7k", 51 "subjectType": "USER", 52 "username": "user1@company.com" 53 }, 54 "workspaceId": "workspaceId" 55 }

Get an alert.

Path parameters

organizationIdstringRequired

The ID of the Organization the alert belongs to.

alertIdstringRequired

The ID of the alert to get.

Response

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

deploymentIdstring or null

The ID of the deployment the alert is associated with.

entityNamestring or null

The name of the entity the alert is associated with.

notificationChannelslist of objects or null

The notification channels to send alerts to.

workspaceIdstring or null

The ID of the workspace the alert is associated with.

Path parameters

Headers

Response

Errors