Get an alert | Astronomer Documentation

{
  "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"
}

Get 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 the alert belongs to.

alertIdstringRequired

The ID of the alert to get.

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

Get Alert Request Bad Request Error

401

Get Alert Request Unauthorized Error

403

Get Alert Request Forbidden Error

404

Get Alert Request Not Found Error

500

Get Alert Request Internal Server Error

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