List alerts | Astronomer Documentation

{
  "alerts": [
    {
      "createdAt": "2023-12-01T09: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": "dep-9f8b7c6a2d3e4f1a",
      "entityType": "DEPLOYMENT",
      "id": "alert-4a5b6c7d8e9f0123",
      "name": "DAG Failure Alert",
      "organizationId": "org-1234567890abcdef",
      "rules": {
        "properties": {
          "threshold": "5",
          "timeWindow": "10m"
        },
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS",
            "values": [
              "marketing_data_etl"
            ]
          }
        ]
      },
      "severity": "CRITICAL",
      "type": "DAG_FAILURE",
      "updatedAt": "2023-12-01T09:45: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-9f8b7c6a2d3e4f1a",
      "entityName": "Marketing Data Pipeline",
      "notificationChannels": [
        {
          "createdAt": "2023-11-15T12:00:00Z",
          "definition": {
            "channel": "#alerts-marketing",
            "webhookUrl": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
          },
          "entityId": "org-1234567890abcdef",
          "entityType": "ORGANIZATION",
          "id": "nc-1234567890abcdef",
          "name": "Marketing Slack Channel",
          "organizationId": "org-1234567890abcdef",
          "type": "SLACK",
          "updatedAt": "2023-11-20T08:30:00Z",
          "deploymentId": "dep-9f8b7c6a2d3e4f1a",
          "workspaceId": "ws-abcdef1234567890"
        }
      ],
      "workspaceId": "ws-abcdef1234567890"
    }
  ]
}

List alerts, including their notification channels. Supports filtering by alert and deployment IDs.

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. At most 1000.

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. At most 1000.

offsetintegerOptional>=0Defaults to 0

The number of results to skip before returning values.

limitintegerOptional0-1000Defaults to 20

The maximum number of results to return.

Response

alertslist of objects

The alerts that were created or updated.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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