> ## 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. # List alerts > List alerts. ## OpenAPI ````yaml /astro/api/v-1-beta-1/platform/openapi.yaml get /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: get: tags: - Alerts summary: List alerts description: List alerts. operationId: ListAlerts parameters: - description: The ID of the Organization to which the alerts belong to. in: path name: organizationId required: true schema: type: string - description: >- A list of IDs for specific alerts to list. The API returns details for all alerts which have been specified in this list. in: query name: alertIds schema: items: type: string type: array - description: >- A list of deployment IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Deployments. in: query name: deploymentIds schema: items: type: string type: array - description: >- A list of workspace IDs the alerts belong to. The API returns details for all alerts belonging only to the specified Workspaces. in: query name: workspaceIds schema: items: type: string type: array - description: >- A list of types for specific alerts to filter by. The API returns details for all alerts belonging only to the specified alert types. in: query name: alertTypes schema: items: enum: - DAG_SUCCESS - DAG_FAILURE - DAG_DURATION - DAG_TIMELINESS - TASK_DURATION - TASK_FAILURE type: string type: array - description: The type of the entity the alerts belong to. in: query name: entityType schema: enum: - DEPLOYMENT type: string - description: The number of results to skip before returning values. in: query name: offset schema: default: 0 minimum: 0 type: integer - description: The maximum number of results to return. in: query name: limit schema: default: 20 maximum: 1000 minimum: 0 type: integer - description: >- A list of field names to sort by, and whether to show results as ascending or descending. Formatted as `:asc` or `:desc`. in: query name: sorts schema: items: enum: - name:asc - name:desc - createdAt:asc - createdAt:desc - updatedAt:asc - updatedAt:desc type: string type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/AlertsPaginated' 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: AlertsPaginated: properties: alerts: description: The list of alerts. items: $ref: '#/components/schemas/Alert' type: array limit: description: The limit for pagination. type: integer offset: description: The offset for pagination. type: integer totalCount: description: The total count of alerts. type: integer required: - alerts - limit - offset - totalCount type: object Error: properties: message: type: string requestId: type: string statusCode: maximum: 600 minimum: 400 type: integer required: - message - requestId - statusCode 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 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 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 securitySchemes: JWT: scheme: bearer type: http ````