Create an alert

POST

Create an alert.

Path parameters

organizationIdstringRequired

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

Request

This endpoint expects an object.

Create Dag Duration Alert Requestobject

Create Dag Failure Alert Requestobject

Create Dag Success Alert Requestobject

Create Dag Timeliness Alert Requestobject

Create Task Duration Alert Requestobject

Create Task Failure Alert Requestobject

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

Allowed values: DEPLOYMENTORGANIZATION

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

Allowed values: INFOWARNINGCRITICAL

The alert’s severity.

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

POST

1 curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "entityId": "entityId",
6   "entityType": "DEPLOYMENT",
7   "name": "name",
8   "notificationChannelIds": [
9     "notificationChannelIds"
10   ],
11   "rules": {
12     "patternMatches": [
13       {
14         "entityType": "DAG_ID TASK_ID",
15         "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
16         "values": [
17           "values"
18         ]
19       }
20     ],
21     "properties": {
22       "dagDurationSeconds": 0,
23       "deploymentId": "deploymentId"
24     }
25   },
26   "severity": "INFO",
27   "type": "DAG_SUCCESS"
28 }'

200Successful

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 }

Built with

1	curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"entityId": "entityId",
6	"entityType": "DEPLOYMENT",
7	"name": "name",
8	"notificationChannelIds": [
9	"notificationChannelIds"
10	],
11	"rules": {
12	"patternMatches": [
13	{
14	"entityType": "DAG_ID TASK_ID",
15	"operatorType": "IS IS_NOT INCLUDES EXCLUDES",
16	"values": [
17	"values"
18	]
19	}
20	],
21	"properties": {
22	"dagDurationSeconds": 0,
23	"deploymentId": "deploymentId"
24	}
25	},
26	"severity": "INFO",
27	"type": "DAG_SUCCESS"
28	}'

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	}