Create an alert | Astronomer Documentation

curl -X POST https://api.astronomer.io/platform/v1beta1/organizations/organizationId/alerts \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "entityId": "entityId",
  "entityType": "DEPLOYMENT",
  "name": "name",
  "notificationChannelIds": [
    "notificationChannelIds"
  ],
  "rules": {
    "patternMatches": [
      {
        "entityType": "TASK_ID",
        "operatorType": "IS",
        "values": [
          "values"
        ]
      }
    ],
    "properties": {
      "dagDurationSeconds": 1,
      "deploymentId": "deploymentId"
    }
  },
  "severity": "INFO",
  "type": "DAG_SUCCESS"
}'

{
  "createdAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "entityId": "entityId",
  "entityType": "DEPLOYMENT",
  "id": "id",
  "name": "name",
  "organizationId": "organizationId",
  "rules": {
    "properties": {
      "key": "value"
    },
    "patternMatches": [
      {
        "entityType": "DAG_ID TASK_ID",
        "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
        "values": [
          "values"
        ]
      }
    ]
  },
  "severity": "INFO",
  "type": "DAG_SUCCESS",
  "updatedAt": "2022-11-22T04:37:12Z",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "deploymentId": "deploymentId",
  "entityName": "entityName",
  "notificationChannels": [
    {
      "createdAt": "2022-11-22T04:37:12Z",
      "definition": {
        "key": "value"
      },
      "entityId": "entityId",
      "entityType": "ORGANIZATION",
      "id": "id",
      "name": "name",
      "organizationId": "organizationId",
      "type": "SLACK",
      "updatedAt": "2022-11-22T04:37:12Z",
      "deploymentId": "deploymentId",
      "workspaceId": "workspaceId"
    }
  ],
  "workspaceId": "workspaceId"
}

Create an alert.

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

Request

This endpoint expects an object.

Create Dag Duration Alert RequestobjectRequired

Create Dag Failure Alert RequestobjectRequired

Create Dag Success Alert RequestobjectRequired

Create Dag Timeliness Alert RequestobjectRequired

Create Task Duration Alert RequestobjectRequired

Create Task Failure Alert RequestobjectRequired

Response

createdAtdatetime

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.

entityType"DEPLOYMENT"

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

The alert's severity.

typeenum

The alert's type.

updatedAtdatetime

The time when the alert was last updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

updatedByobject

deploymentIdstring

The ID of the deployment the alert is associated with.

entityNamestring

The name of the entity the alert is associated with.

notificationChannelslist of objects

The notification channels to send alerts to.

workspaceIdstring

The ID of the workspace the alert is associated with.

Errors

400

Create Alert Body Bad Request Error

401

Create Alert Body Unauthorized Error

403

Create Alert Body Forbidden Error

404

Create Alert Body Not Found Error

500

Create Alert Body Internal Server Error