> ## Documentation Index
> Fetch the complete documentation index at: https://astronomer.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an alert

> Create an alert.



## OpenAPI

````yaml /astro/api/v-1-beta-1/platform/openapi.yaml post /organizations/{organizationId}/alerts
openapi: 3.0.3
info:
  contact: {}
  description: Astro Platform API
  title: Astro Platform API
  version: v1beta1
servers:
  - url: https://api.astronomer.io/platform/v1beta1
security:
  - JWT: []
tags:
  - description: >-
      A `cluster` object represents an Astro cluster, which is a Kubernetes
      cluster that hosts the infrastructure required to run Deployments. Make
      requests to `cluster` endpoints to manage your standard and dedicated
      clusters. See [Create a dedicated
      cluster](https://astronomer.io/docs/astro/create-dedicated-cluster).
    name: Cluster
  - description: >-
      The `organization` object contains the metadata and configurations of an
      Astro Organization. It does not include objects within the Organization,
      such as users and clusters. Make requests to `organization` endpoints to
      view and update high level settings for your Organization, including
      settings related to authentication and billing. To manage resources within
      an Organization, make requests to the endpoints related to those
      resources, such as `users`. See
      [Billing](https://astronomer.io/docs/astro/manage-billing), [Set up single
      sign-on](https://astronomer.io/docs/astro/configure-idp), and [Manage
      domains](https://astronomer.io/docs/astro/manage-domains).
    name: Organization
  - description: >-
      The `options` object represents all possible configurations for a given
      Astro component. Make requests to the `options` object to get the
      configuration constraints for creating or updating a given Astro
      component.
    name: Options
  - description: >-
      The `workspace` object represents an Astro Workspace, which is a
      collection of Deployments that can be accessed by a specific group of
      users. It contains metadata about a Workspace, but does not contain
      objects within the Workspace such as users and Deployments. Make requests
      to `workspace` endpoints to manage high level details about your
      Workspace. To manage resources within a Workspace, make requests to the
      endpoints related to those resources, such as `users`, and use the
      `workspaceIds` parameter to filter results by Workspace. See [Configure
      Workspaces](https://astronomer.io/docs/astro/manage-workspaces).
    name: Workspace
  - name: notification-channels
    x-group: Notification Channels
paths:
  /organizations/{organizationId}/alerts:
    post:
      tags:
        - Alerts
      summary: Create an alert
      description: Create an alert.
      operationId: CreateAlert
      parameters:
        - description: The ID of the Organization to which the alert will belong to.
          in: path
          name: organizationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAlertRequest'
        description: The request body for creating a new alert.
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal Server Error
      security:
        - JWT: []
components:
  schemas:
    CreateAlertRequest:
      discriminator:
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/CreateDagDurationAlertRequest'
        - $ref: '#/components/schemas/CreateDagFailureAlertRequest'
        - $ref: '#/components/schemas/CreateDagSuccessAlertRequest'
        - $ref: '#/components/schemas/CreateDagTimelinessAlertRequest'
        - $ref: '#/components/schemas/CreateTaskDurationAlertRequest'
        - $ref: '#/components/schemas/CreateTaskFailureAlertRequest'
      type: object
    Alert:
      properties:
        createdAt:
          description: >-
            The time when the alert was created in UTC, formatted as
            `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-11-22T04:37:12Z'
          format: date-time
          type: string
        createdBy:
          $ref: '#/components/schemas/BasicSubjectProfile'
        deploymentId:
          description: The ID of the deployment the alert is associated with.
          type: string
        entityId:
          description: The ID of the entity the alert is associated with.
          type: string
        entityName:
          description: The name of the entity the alert is associated with.
          type: string
        entityType:
          description: The type of entity the alert is associated with.
          enum:
            - DEPLOYMENT
          type: string
        id:
          description: The alert's ID.
          type: string
        name:
          description: The alert's name.
          type: string
        notificationChannels:
          description: The notification channels to send alerts to.
          items:
            $ref: '#/components/schemas/AlertNotificationChannel'
          type: array
        organizationId:
          description: The ID of the organization the alert is associated with.
          type: string
        rules:
          $ref: '#/components/schemas/AlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
            - DATA_PRODUCT_SLA
            - DATA_PRODUCT_PROACTIVE_FAILURE
            - DATA_PRODUCT_PROACTIVE_SLA
            - AIRFLOW_DB_STORAGE_UNUSUALLY_HIGH
            - DEPRECATED_RUNTIME_VERSION
            - JOB_SCHEDULING_DISABLED
            - WORKER_QUEUE_AT_CAPACITY
          type: string
        updatedAt:
          description: >-
            The time when the alert was last updated in UTC, formatted as
            `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-11-22T04:37:12Z'
          format: date-time
          type: string
        updatedBy:
          $ref: '#/components/schemas/BasicSubjectProfile'
        workspaceId:
          description: The ID of the workspace the alert is associated with.
          type: string
      required:
        - createdAt
        - createdBy
        - entityId
        - entityType
        - id
        - name
        - organizationId
        - rules
        - severity
        - type
        - updatedAt
        - updatedBy
      type: object
    Error:
      properties:
        message:
          type: string
        requestId:
          type: string
        statusCode:
          maximum: 600
          minimum: 400
          type: integer
      required:
        - message
        - requestId
        - statusCode
      type: object
    CreateDagDurationAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateDagDurationAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    CreateDagFailureAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateDagFailureAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    CreateDagSuccessAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateDagSuccessAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    CreateDagTimelinessAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateDagTimelinessAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    CreateTaskDurationAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateTaskDurationAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    CreateTaskFailureAlertRequest:
      properties:
        entityId:
          description: The entity ID the alert is associated with.
          type: string
        entityType:
          description: The ID of the Deployment to which the alert is scoped.
          enum:
            - DEPLOYMENT
          type: string
        name:
          description: The alert's name.
          maxLength: 500
          minLength: 1
          type: string
        notificationChannelIds:
          description: The notification channels to send alerts to.
          items:
            type: string
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/CreateTaskFailureAlertRules'
        severity:
          description: The alert's severity.
          enum:
            - INFO
            - WARNING
            - CRITICAL
          type: string
        type:
          description: The alert's type.
          enum:
            - DAG_SUCCESS
            - DAG_FAILURE
            - DAG_DURATION
            - DAG_TIMELINESS
            - TASK_DURATION
            - TASK_FAILURE
          type: string
      required:
        - entityId
        - entityType
        - name
        - notificationChannelIds
        - rules
        - severity
        - type
      type: object
    BasicSubjectProfile:
      properties:
        apiTokenName:
          description: >-
            The API token's name. Returned only when `SubjectType` is
            `SERVICEKEY`.
          example: my-token
          type: string
        avatarUrl:
          description: >-
            The URL for the user's profile image. Returned only when
            `SubjectType` is `USER`.
          example: https://avatar.url
          type: string
        fullName:
          description: The subject's full name. Returned only when `SubjectType` is `USER`.
          example: Jane Doe
          type: string
        id:
          description: The subject's ID.
          example: clm8qv74h000008mlf08scq7k
          type: string
        subjectType:
          description: The subject type.
          enum:
            - USER
            - SERVICEKEY
          example: USER
          type: string
        username:
          description: The subject's username. Returned only when `SubjectType` is `USER`.
          example: user1@company.com
          type: string
      required:
        - id
      type: object
    AlertNotificationChannel:
      properties:
        createdAt:
          description: >-
            The time when the notification channel was created in UTC, formatted
            as `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-11-22T04:37:12Z'
          format: date-time
          type: string
        definition:
          description: The definition of the notification.
        deploymentId:
          description: >-
            The ID of the deployment the notification channel is associated
            with.
          type: string
        entityId:
          description: The ID of the entity the notification channel is associated with.
          type: string
        entityType:
          description: The type of entity the notification channel is associated with.
          enum:
            - ORGANIZATION
            - WORKSPACE
            - DEPLOYMENT
          type: string
        id:
          description: The ID of the notification channel.
          type: string
        name:
          description: The name of the notification channel.
          type: string
        organizationId:
          description: >-
            The ID of the organization the notification channel is associated
            with.
          type: string
        type:
          description: The type of the notification channel.
          enum:
            - SLACK
            - EMAIL
            - PAGERDUTY
            - DAG_TRIGGER
            - OPSGENIE
          type: string
        updatedAt:
          description: >-
            The time when the notification channel was last updated in UTC,
            formatted as `YYYY-MM-DDTHH:MM:SSZ`.
          example: '2022-11-22T04:37:12Z'
          format: date-time
          type: string
        workspaceId:
          description: The ID of the workspace the notification channel is associated with.
          type: string
      required:
        - createdAt
        - definition
        - entityId
        - entityType
        - id
        - name
        - organizationId
        - type
        - updatedAt
      type: object
    AlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatch'
          type: array
        properties:
          description: The alert's properties used to define the alert.
      required:
        - properties
      type: object
    CreateDagDurationAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateDagDurationAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    CreateDagFailureAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateDagFailureAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    CreateDagSuccessAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateDagSuccessAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    CreateDagTimelinessAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateDagTimelinessAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    CreateTaskDurationAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateTaskDurationAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    CreateTaskFailureAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/CreateTaskFailureAlertProperties'
      required:
        - patternMatches
        - properties
      type: object
    PatternMatch:
      properties:
        entityType:
          description: The type of entity to match against.
          enum:
            - DAG_ID TASK_ID
          type: string
        operatorType:
          description: The type of operator to use for the pattern match.
          enum:
            - IS IS_NOT INCLUDES EXCLUDES
          type: string
        values:
          description: The values to match against.
          items:
            type: string
          type: array
      required:
        - entityType
        - operatorType
        - values
      type: object
    PatternMatchRequest:
      properties:
        entityType:
          description: The type of entity to match against.
          enum:
            - TASK_ID
            - DAG_ID
          type: string
        operatorType:
          description: The type of operator to use for the pattern match.
          enum:
            - IS
            - IS_NOT
            - INCLUDES
            - EXCLUDES
          type: string
        values:
          description: The values to match against.
          items:
            type: string
          minItems: 1
          type: array
      required:
        - entityType
        - operatorType
        - values
      type: object
    CreateDagDurationAlertProperties:
      properties:
        dagDurationSeconds:
          description: The duration of the DAG in seconds.
          maximum: 86400
          minimum: 60
          type: integer
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
      required:
        - dagDurationSeconds
        - deploymentId
      type: object
    CreateDagFailureAlertProperties:
      properties:
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
      required:
        - deploymentId
      type: object
    CreateDagSuccessAlertProperties:
      properties:
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
      required:
        - deploymentId
      type: object
    CreateDagTimelinessAlertProperties:
      properties:
        dagDeadline:
          description: The deadline for the DAG in HH:MM 24-hour format, in UTC time.
          type: string
        daysOfWeek:
          description: The days of the week for the alert.
          items:
            type: string
          maxItems: 7
          minItems: 1
          type: array
          uniqueItems: true
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
        lookBackPeriodSeconds:
          description: The look-back period in seconds.
          maximum: 86400
          minimum: 60
          type: integer
      required:
        - dagDeadline
        - daysOfWeek
        - deploymentId
        - lookBackPeriodSeconds
      type: object
    CreateTaskDurationAlertProperties:
      properties:
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
        taskDurationSeconds:
          description: The duration of the Task in seconds.
          maximum: 86400
          minimum: 60
          type: integer
      required:
        - deploymentId
        - taskDurationSeconds
      type: object
    CreateTaskFailureAlertProperties:
      properties:
        deploymentId:
          description: The ID of the deployment to which the alert is scoped.
          type: string
      required:
        - deploymentId
      type: object
  securitySchemes:
    JWT:
      scheme: bearer
      type: http

````