Update an alert

POST

Update an alert.

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 Requestobject

Update Dag Failure Alert Requestobject

Update Dag Success Alert Requestobject

Update Dag Timeliness Alert Requestobject

Update Task Duration Alert Requestobject

Update 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/alertId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "name",
6   "notificationChannelIds": [
7     "notificationChannelIds"
8   ],
9   "rules": {
10     "patternMatches": [
11       {
12         "entityType": "DAG_ID TASK_ID",
13         "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
14         "values": [
15           "values"
16         ]
17       }
18     ],
19     "properties": {
20       "dagDurationSeconds": 0
21     }
22   },
23   "severity": "INFO",
24   "type": "DAG_SUCCESS"
25 }'

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/alertId \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"notificationChannelIds": [
7	"notificationChannelIds"
8	],
9	"rules": {
10	"patternMatches": [
11	{
12	"entityType": "DAG_ID TASK_ID",
13	"operatorType": "IS IS_NOT INCLUDES EXCLUDES",
14	"values": [
15	"values"
16	]
17	}
18	],
19	"properties": {
20	"dagDurationSeconds": 0
21	}
22	},
23	"severity": "INFO",
24	"type": "DAG_SUCCESS"
25	}'

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	}