List alerts

Error

A valid request URL is required to generate request examples

{
  "alerts": [
    {
      "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": "<string>",
      "entityType": "DEPLOYMENT",
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "rules": {
        "properties": "<unknown>",
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
            "values": [
              "<string>"
            ]
          }
        ]
      },
      "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": "<string>",
      "entityName": "<string>",
      "notificationChannels": [
        {
          "createdAt": "2022-11-22T04:37:12Z",
          "definition": "<unknown>",
          "entityId": "<string>",
          "entityType": "ORGANIZATION",
          "id": "<string>",
          "name": "<string>",
          "organizationId": "<string>",
          "type": "SLACK",
          "updatedAt": "2022-11-22T04:37:12Z",
          "deploymentId": "<string>",
          "workspaceId": "<string>"
        }
      ],
      "workspaceId": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

GET

organizations

{organizationId}

alerts

Error

A valid request URL is required to generate request examples

{
  "alerts": [
    {
      "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": "<string>",
      "entityType": "DEPLOYMENT",
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "rules": {
        "properties": "<unknown>",
        "patternMatches": [
          {
            "entityType": "DAG_ID TASK_ID",
            "operatorType": "IS IS_NOT INCLUDES EXCLUDES",
            "values": [
              "<string>"
            ]
          }
        ]
      },
      "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": "<string>",
      "entityName": "<string>",
      "notificationChannels": [
        {
          "createdAt": "2022-11-22T04:37:12Z",
          "definition": "<unknown>",
          "entityId": "<string>",
          "entityType": "ORGANIZATION",
          "id": "<string>",
          "name": "<string>",
          "organizationId": "<string>",
          "type": "SLACK",
          "updatedAt": "2022-11-22T04:37:12Z",
          "deploymentId": "<string>",
          "workspaceId": "<string>"
        }
      ],
      "workspaceId": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

The ID of the Organization to which the alerts belong to.

Query Parameters

alertIds

string[]

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.

deploymentIds

string[]

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.

offset

integer

default:0

The number of results to skip before returning values.

Required range: x >= 0

limit

integer

default:20

The maximum number of results to return.

Required range: 0 <= x <= 1000

Response

alerts

object[]

required

The alerts that were created or updated.

Show child attributes

⌘I

Astro API v1labs

API Reference

Authorizations

Path Parameters

Query Parameters

Response