Bulk update alerts | Astronomer Documentation

curl -X POST https://api.astronomer.io/labs/v1/organizations/organizationId/update-alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "alerts": [
    {}
  ]
}'

{
  "alerts": [
    {
      "createdAt": "2023-11-22T04:37:12Z",
      "createdBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.example.com/u/12345.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "entityId": "ent_01F8XYZ1234567890",
      "entityType": "DEPLOYMENT",
      "id": "alert_01F8XYZ1234567890",
      "name": "Critical DAG Success Alert",
      "organizationId": "org_01F8XYZ1234567890",
      "rules": {
        "properties": null,
        "patternMatches": [
          {
            "entityType": "DAG_ID",
            "operatorType": "IS",
            "values": [
              "data_pipeline_dag"
            ]
          }
        ]
      },
      "severity": "CRITICAL",
      "type": "DAG_SUCCESS",
      "updatedAt": "2023-11-22T04:37:12Z",
      "updatedBy": {
        "id": "clm8qv74h000008mlf08scq7k",
        "apiTokenName": "deployment-service-key",
        "avatarUrl": "https://avatars.example.com/u/12345.png",
        "fullName": "Jane Doe",
        "subjectType": "USER",
        "username": "jane.doe@astronomer.io"
      },
      "deploymentId": "dep_01F8XYZ1234567890",
      "entityName": "Data Pipeline DAG",
      "notificationChannels": [
        {
          "createdAt": "2023-11-20T10:15:30Z",
          "definition": null,
          "entityId": "org_01F8XYZ1234567890",
          "entityType": "ORGANIZATION",
          "id": "nc_01F8XYZ1234567890",
          "name": "Slack Alerts Channel",
          "organizationId": "org_01F8XYZ1234567890",
          "type": "SLACK",
          "updatedAt": "2023-11-21T12:00:00Z",
          "deploymentId": "dep_01F8XYZ1234567890",
          "workspaceId": "ws_01F8XYZ1234567890"
        }
      ],
      "workspaceId": "ws_01F8XYZ1234567890"
    }
  ]
}

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

Request

The request body for updating multiple alerts.

alertslist of objectsRequired

The alerts to update. 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