Bulk create alerts | Astronomer Documentation

curl -X POST https://api.astronomer.io/labs/v1/organizations/organizationId/create-alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "alerts": [
    {
      "type": "DAG_SUCCESS",
      "entityId": "dep-12345",
      "entityType": "DEPLOYMENT",
      "name": "Daily DAG Success Alert",
      "notificationChannelIds": [
        "nc-67890"
      ],
      "rules": {
        "patternMatches": [
          {
            "entityType": "TASK_ID",
            "operatorType": "IS",
            "values": [
              "task_01"
            ]
          }
        ],
        "properties": {
          "deploymentId": "dep-12345",
          "dagDurationSeconds": 3600
        }
      },
      "severity": "INFO"
    }
  ]
}'

{
  "alerts": [
    {
      "createdAt": "2024-04-10T08:15:30Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-token",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "entityId": "dep-12345",
      "entityType": "DEPLOYMENT",
      "id": "alert-98765",
      "name": "Daily DAG Success Alert",
      "organizationId": "org-54321",
      "rules": {
        "properties": null,
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
            "values": [
              "task_01"
            ]
          }
        ]
      },
      "severity": "INFO",
      "type": "DAG_SUCCESS",
      "updatedAt": "2024-04-10T08:15:30Z",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-token",
        "avatarUrl": "https://avatars.astronomer.io/users/janedoe.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "deploymentId": "dep-12345",
      "entityName": "Production Deployment",
      "notificationChannels": [
        {
          "createdAt": "2024-04-01T12:00:00Z",
          "definition": null,
          "entityId": "org-54321",
          "entityType": "ORGANIZATION",
          "id": "nc-67890",
          "name": "Slack Alerts Channel",
          "organizationId": "org-54321",
          "type": "SLACK",
          "updatedAt": "2024-04-05T09:30:00Z",
          "deploymentId": "dep-12345",
          "workspaceId": "ws-11223"
        }
      ],
      "workspaceId": "ws-11223"
    }
  ]
}

Create up to 30 alerts in a single request.

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

Request

The request body for creating multiple alerts.

alertslist of objectsRequired

The alerts to create. At most 30 per request.

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