List alerts | Astronomer Documentation

curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "alerts": [
    {
      "createdAt": "2024-04-10T09:15:30Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "entityId": "dag-9876zyxw4321vuts",
      "entityType": "DEPLOYMENT",
      "id": "alert-0011223344556677",
      "name": "Daily DAG Success Alert",
      "organizationId": "org-8765dcba4321hgfe",
      "rules": {
        "properties": {
          "threshold": "100%",
          "timeWindow": "24h"
        },
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS",
            "values": [
              "daily_data_pipeline"
            ]
          }
        ]
      },
      "severity": "INFO",
      "type": "DAG_SUCCESS",
      "updatedAt": "2024-04-10T09:20:00Z",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "deploymentId": "dep-1234abcd5678efgh",
      "entityName": "daily_data_pipeline",
      "notificationChannels": [
        {
          "createdAt": "2024-04-01T12:00:00Z",
          "definition": "Slack channel #alerts for deployment notifications",
          "entityId": "org-8765dcba4321hgfe",
          "entityType": "ORGANIZATION",
          "id": "notif-9988776655443322",
          "name": "Slack Alerts Channel",
          "organizationId": "org-8765dcba4321hgfe",
          "type": "SLACK",
          "updatedAt": "2024-04-05T15:30:00Z",
          "deploymentId": "dep-1234abcd5678efgh",
          "workspaceId": "ws-1122334455667788"
        }
      ],
      "workspaceId": "ws-1122334455667788"
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

List alerts.

curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "alerts": [
    {
      "createdAt": "2024-04-10T09:15:30Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "entityId": "dag-9876zyxw4321vuts",
      "entityType": "DEPLOYMENT",
      "id": "alert-0011223344556677",
      "name": "Daily DAG Success Alert",
      "organizationId": "org-8765dcba4321hgfe",
      "rules": {
        "properties": {
          "threshold": "100%",
          "timeWindow": "24h"
        },
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS",
            "values": [
              "daily_data_pipeline"
            ]
          }
        ]
      },
      "severity": "INFO",
      "type": "DAG_SUCCESS",
      "updatedAt": "2024-04-10T09:20:00Z",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "deploymentId": "dep-1234abcd5678efgh",
      "entityName": "daily_data_pipeline",
      "notificationChannels": [
        {
          "createdAt": "2024-04-01T12:00:00Z",
          "definition": "Slack channel #alerts for deployment notifications",
          "entityId": "org-8765dcba4321hgfe",
          "entityType": "ORGANIZATION",
          "id": "notif-9988776655443322",
          "name": "Slack Alerts Channel",
          "organizationId": "org-8765dcba4321hgfe",
          "type": "SLACK",
          "updatedAt": "2024-04-05T15:30:00Z",
          "deploymentId": "dep-1234abcd5678efgh",
          "workspaceId": "ws-1122334455667788"
        }
      ],
      "workspaceId": "ws-1122334455667788"
    }
  ],
  "limit": 1,
  "offset": 1,
  "totalCount": 1
}

List alerts.

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 alerts belong to.

Query parameters

alertIdslist of stringsOptional

A list of IDs for specific alerts to list. The API returns details for all alerts which have been specified in this list.

deploymentIdslist of stringsOptional

A list of deployment IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Deployments.

workspaceIdslist of stringsOptional

A list of workspace IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Workspaces.

alertTypeslist of enumsOptional

A list of types for specific alerts to filter by. The API returns details for all alerts belonging only to the specified alert types.

entityTypeenumOptional

The type of the entity the alerts belong to.

Allowed values:

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning values.

limitintegerOptional0-1000Defaults to 20

The maximum number of results to return.

sortslist of enumsOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

alertslist of objects

The list of alerts.

limitinteger

The limit for pagination.

offsetinteger

The offset for pagination.

totalCountinteger

The total count of alerts.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"alerts": [
3	{
4	"createdAt": "2024-04-10T09:15:30Z",
5	"createdBy": {
6	"id": "clm8qv74h000008mlf08scq7k",
7	"apiTokenName": "deployment-service-key",
8	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
9	"fullName": "Jane Doe",
10	"subjectType": "USER",
11	"username": "jane.doe@astronomer.io"
12	},
13	"entityId": "dag-9876zyxw4321vuts",
14	"entityType": "DEPLOYMENT",
15	"id": "alert-0011223344556677",
16	"name": "Daily DAG Success Alert",
17	"organizationId": "org-8765dcba4321hgfe",
18	"rules": {
19	"properties": {
20	"threshold": "100%",
21	"timeWindow": "24h"
22	},
23	"patternMatches": [
24	{
25	"entityType": "DAG_ID TASK_ID",
26	"operatorType": "IS",
27	"values": [
28	"daily_data_pipeline"
29	]
30	}
31	]
32	},
33	"severity": "INFO",
34	"type": "DAG_SUCCESS",
35	"updatedAt": "2024-04-10T09:20:00Z",
36	"updatedBy": {
37	"id": "clm8qv74h000008mlf08scq7k",
38	"apiTokenName": "deployment-service-key",
39	"avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
40	"fullName": "Jane Doe",
41	"subjectType": "USER",
42	"username": "jane.doe@astronomer.io"
43	},
44	"deploymentId": "dep-1234abcd5678efgh",
45	"entityName": "daily_data_pipeline",
46	"notificationChannels": [
47	{
48	"createdAt": "2024-04-01T12:00:00Z",
49	"definition": "Slack channel #alerts for deployment notifications",
50	"entityId": "org-8765dcba4321hgfe",
51	"entityType": "ORGANIZATION",
52	"id": "notif-9988776655443322",
53	"name": "Slack Alerts Channel",
54	"organizationId": "org-8765dcba4321hgfe",
55	"type": "SLACK",
56	"updatedAt": "2024-04-05T15:30:00Z",
57	"deploymentId": "dep-1234abcd5678efgh",
58	"workspaceId": "ws-1122334455667788"
59	}
60	],
61	"workspaceId": "ws-1122334455667788"
62	}
63	],
64	"limit": 1,
65	"offset": 1,
66	"totalCount": 1
67	}