> ## 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.

# Bulk update alerts

> Update up to 30 alerts in a single request.



## OpenAPI

````yaml /astro/api/v-1-labs/openapi.yaml post /organizations/{organizationId}/update-alerts
openapi: 3.0.3
info:
  contact: {}
  description: Astro Labs API - Experimental endpoints for preview features
  title: Astro Labs API
  version: v1
servers:
  - url: https://api.astronomer.io/labs/v1
security:
  - JWT: []
tags:
  - description: >-
      Canned-data placeholder used to exercise the labs epoch versioning
      surface. Real labs endpoints register their own tags.
    name: Example
paths:
  /organizations/{organizationId}/update-alerts:
    post:
      tags:
        - Alerts
      summary: Bulk update alerts
      description: Update up to 30 alerts in a single request.
      operationId: LabsUpdateAlerts
      parameters:
        - description: The ID of the Organization to which the alerts belong to.
          in: path
          name: organizationId
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAlertsRequest'
        description: The request body for updating multiple alerts.
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsList'
          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:
    UpdateAlertsRequest:
      properties:
        alerts:
          description: The alerts to update. At most 30 per request.
          items:
            $ref: '#/components/schemas/UpdateAlertRequest'
          maxItems: 30
          minItems: 1
          type: array
      required:
        - alerts
      type: object
    AlertsList:
      properties:
        alerts:
          description: The alerts that were created or updated.
          items:
            $ref: '#/components/schemas/Alert'
          type: array
      required:
        - alerts
      type: object
    Error:
      properties:
        fieldErrors:
          description: >-
            FieldErrors carries one entry per failed request-validation
            constraint.

            Only present on 400 responses caused by request binding/validation.
          items:
            $ref: '#/components/schemas/FieldValidationError'
          type: array
        message:
          type: string
        requestId:
          type: string
        statusCode:
          maximum: 600
          minimum: 400
          type: integer
      required:
        - message
        - requestId
        - statusCode
      type: object
    UpdateAlertRequest:
      discriminator:
        mapping:
          DAG_DURATION:
            $ref: '#/components/schemas/UpdateDagDurationAlertRequest'
          DAG_FAILURE:
            $ref: '#/components/schemas/UpdateDagFailureAlertRequest'
          DAG_SUCCESS:
            $ref: '#/components/schemas/UpdateDagSuccessAlertRequest'
          DAG_TIMELINESS:
            $ref: '#/components/schemas/UpdateDagTimelinessAlertRequest'
          TASK_DURATION:
            $ref: '#/components/schemas/UpdateTaskDurationAlertRequest'
          TASK_FAILURE:
            $ref: '#/components/schemas/UpdateTaskFailureAlertRequest'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/UpdateDagDurationAlertRequest'
        - $ref: '#/components/schemas/UpdateDagFailureAlertRequest'
        - $ref: '#/components/schemas/UpdateDagSuccessAlertRequest'
        - $ref: '#/components/schemas/UpdateDagTimelinessAlertRequest'
        - $ref: '#/components/schemas/UpdateTaskDurationAlertRequest'
        - $ref: '#/components/schemas/UpdateTaskFailureAlertRequest'
      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
          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
    FieldValidationError:
      properties:
        code:
          type: string
        field:
          type: string
        message:
          type: string
      required:
        - code
        - field
        - message
      type: object
    UpdateDagDurationAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateDagDurationAlertRules'
        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
      type: object
    UpdateDagFailureAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateDagFailureAlertRules'
        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
      type: object
    UpdateDagSuccessAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateDagSuccessAlertRules'
        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
      type: object
    UpdateDagTimelinessAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateDagTimelinessAlertRules'
        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
      type: object
    UpdateTaskDurationAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateTaskDurationAlertRules'
        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
      type: object
    UpdateTaskFailureAlertRequest:
      properties:
        id:
          description: The alert's ID. Required when updating alerts in bulk.
          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
          maxItems: 20
          minItems: 1
          type: array
          uniqueItems: true
        rules:
          $ref: '#/components/schemas/UpdateTaskFailureAlertRules'
        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
      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
    UpdateDagDurationAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/UpdateDagDurationAlertProperties'
      type: object
    UpdateDagFailureAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
      type: object
    UpdateDagSuccessAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
      type: object
    UpdateDagTimelinessAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/UpdateDagTimelinessAlertProperties'
      type: object
    UpdateTaskDurationAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
        properties:
          $ref: '#/components/schemas/UpdateTaskDurationAlertProperties'
      type: object
    UpdateTaskFailureAlertRules:
      properties:
        patternMatches:
          description: The alert's pattern matches to match against.
          items:
            $ref: '#/components/schemas/PatternMatchRequest'
          maxItems: 50
          minItems: 1
          type: array
      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
          maxItems: 100
          minItems: 1
          type: array
      required:
        - entityType
        - operatorType
        - values
      type: object
    UpdateDagDurationAlertProperties:
      properties:
        dagDurationSeconds:
          description: >-
            The duration of the DAG in seconds. Min 60 (1 minute), max 604800 (7
            days).
          maximum: 604800
          minimum: 60
          type: integer
      type: object
    UpdateDagTimelinessAlertProperties:
      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
        lookBackPeriodSeconds:
          description: The look-back period in seconds.
          maximum: 86400
          minimum: 60
          type: integer
      type: object
    UpdateTaskDurationAlertProperties:
      properties:
        taskDurationSeconds:
          description: The duration of the Task in seconds.
          maximum: 86400
          minimum: 60
          type: integer
      type: object
  securitySchemes:
    JWT:
      scheme: bearer
      type: http

````