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

# Listar alertas de métricas

> Paginación por cursor y UUID en orden ascendente, limitada a la cuenta. Los marcadores son opacos y están vinculados a la cuenta y los filtros. La respuesta no incluye la identidad del inquilino.



## OpenAPI

````yaml /es/api-reference/specs/telemetry.yaml get /v1/alerts
openapi: 3.0.3
info:
  title: API de telemetría basaltica
  version: 1.0.0
  description: >
    API regional de telemetría: grupos de logs, ingesta y búsqueda de logs,
    ingesta remote_write, consultas estructuradas de métricas en JSON, spans,
    búsqueda y detalles de trazas y configuración por cuenta.


    Las referencias de grupos de logs aceptan UUID, CRN o nombre exacto en la
    cuenta, clasificados por sintaxis sin búsqueda alternativa. Los CRN deben
    corresponder a la cuenta autenticada y la región. Los logs OTLP HTTP y gRPC
    usan basaltic.log_group o service.name con el mismo contrato. Los
    identificadores de trazas y spans, las etiquetas de métricas y las regiones
    de búsqueda son valores de protocolo independientes de la resolución de
    recursos.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://telemetry.{region}.basaltic.sh
    description: Endpoint de API regional (uno por región)
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de región
security:
  - BearerAuth: []
paths:
  /v1/alerts:
    get:
      tags:
        - Telemetry
      summary: Listar alertas de métricas
      description: >-
        Paginación por cursor y UUID en orden ascendente, limitada a la cuenta.
        Los marcadores son opacos y están vinculados a la cuenta y los filtros.
        La respuesta no incluye la identidad del inquilino.
      operationId: listAlerts
      parameters:
        - name: name
          in: query
          description: >-
            Filtro por nombre exacto; un nombre explícitamente vacío no coincide
            con ningún resultado.
          schema:
            type: string
        - name: crn
          in: query
          description: >-
            CRN canónico exacto de la alerta, combinado con name y state. Los
            CRN vacíos o malformados devuelven 400; los CRN válidos de otra
            cuenta o región devuelven una página vacía.
          schema:
            type: string
        - name: state
          in: query
          description: >-
            Filtra el estado efectivo. Deshabilitado tiene prioridad sobre
            silenciado; en los demás casos usa el estado de evaluación.
          schema:
            type: string
            enum:
              - ok
              - pending
              - firing
              - no_data
              - error
              - silenced
              - disabled
        - $ref: '#/components/parameters/LimitDefault50'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Listar alertas de métricas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    LimitDefault50:
      name: limit
      in: query
      description: >-
        Número máximo de artículos a devolver. Un valor por encima del máximo se
        le aplica en lugar de rechazarlo, por lo que una página más corta que la
        que solicitaste es normal — page until `meta.has_more` es falso, no
        hasta que una página se vea corta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      example: 50
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginación opaco. Hacer eco del valor `meta.marker` de la
        página anterior para buscar la siguiente; no construirlo ni analizarlo.
        La forma interna del token varía según el punto final (un ID de recurso,
        una marca de tiempo, etc.) y no se garantiza su estabilidad entre
        versiones.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    AlertListResponse:
      type: object
      required:
        - alerts
        - meta
      properties:
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/Alert'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Alert:
      type: object
      required:
        - id
        - crn
        - name
        - topic
        - expression
        - operator
        - threshold
        - window_seconds
        - for_seconds
        - enabled
        - silenced_until
        - state
        - last_value
        - created_at
        - updated_at
      properties:
        expression:
          $ref: '#/components/schemas/AlertExpression'
        operator:
          type: string
          enum:
            - gt
            - gte
            - lt
            - lte
        threshold:
          type: number
          format: double
        window_seconds:
          type: integer
          minimum: 60
          maximum: 3600
          multipleOf: 60
          description: >-
            Ventana de minutos enteros. Se evalúa cada minuto usando la última
            ventana completa alineada con UTC.
        for_seconds:
          type: integer
          minimum: 0
          maximum: 86400
          multipleOf: 60
          description: >-
            Duración continua del incumplimiento antes del disparo; 0 dispara
            inmediatamente. Los datos ausentes, los fallos de consulta y los
            intervalos sin evaluación reinician la duración pendiente.
        enabled:
          type: boolean
          default: true
        silenced_until:
          type: string
          format: date-time
          nullable: true
          description: >-
            Silencia las notificaciones hasta este instante (como máximo 30 días
            en el futuro). La evaluación continúa; null elimina el silencio. Una
            alerta activa notifica en la siguiente evaluación después de que
            expire el silencio.
        id:
          type: string
          format: uuid
        crn:
          type: string
          example: crn:telemetry:sa-saopaulo-1:my-account:alert/high-cpu
        name:
          type: string
        topic:
          $ref: '#/components/schemas/ResourceRef'
        state:
          type: string
          enum:
            - ok
            - pending
            - firing
            - no_data
            - error
          description: >-
            Estado de evaluación, independiente de enabled y silenced_until. Los
            datos ausentes o los errores no resuelven un incidente abierto.
        last_value:
          type: number
          format: double
          nullable: true
        evaluated_at:
          type: string
          format: date-time
        state_changed_at:
          type: string
          format: date-time
        pending_since:
          type: string
          format: date-time
        evaluation_error:
          type: string
        delivery_error:
          type: string
          description: >-
            La notificación permanece en cola para reintentarse; la evaluación
            de la métrica continúa.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de artículos
          example: 150
        limit:
          type: integer
          description: Número de artículos por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para la página siguiente. Pasalo de vuelta como el
            parámetro de consulta `marker`; trátalo como un token, no como un
            valor para analizar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Si hay más artículos
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
    AlertExpression:
      type: object
      additionalProperties: false
      required:
        - metric
        - agg
        - scale
      properties:
        metric:
          type: string
          maxLength: 256
          pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$
        agg:
          type: string
          enum:
            - avg
            - min
            - max
            - sum
            - last
            - count
            - rate
            - increase
        match:
          type: array
          maxItems: 40
          items:
            type: string
          description: >-
            Filtros de etiqueta (label=value, label!=value, label=~regex,
            label!~regex). El ámbito del inquilino siempre se aplica de forma
            independiente.
        by:
          type: array
          maxItems: 10
          items:
            type: string
          description: >-
            Etiquetas de agrupación; las series resultantes se suman para
            coincidir con la tarjeta de métrica de la consola.
        denominator:
          $ref: '#/components/schemas/AlertQuery'
        scale:
          type: number
          format: double
          minimum: 0
          exclusiveMinimum: true
          maximum: 1000000000000
          description: >-
            Multiplicador después de la división opcional, por ejemplo, 100 para
            un porcentaje o 1/1048576 para MiB/s.
        unit:
          type: string
          maxLength: 32
          description: >-
            Unidad de visualización del umbral y del valor después de aplicar la
            escala.
    ResourceRef:
      type: object
      required:
        - id
        - crn
      properties:
        id:
          type: string
          format: uuid
          example: 288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        crn:
          type: string
          example: crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1
        name:
          type: string
          description: >-
            Etiqueta en el momento de la respuesta: el nombre del recurso, si lo
            tiene, o su etiqueta legible (número de factura, nombre de
            visualización de la cuenta). Ausente cuando el destino ya no existe.
            No es una clave de búsqueda.
          example: Brazil
    AlertQuery:
      type: object
      additionalProperties: false
      required:
        - metric
        - agg
      properties:
        metric:
          type: string
          maxLength: 256
          pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$
        agg:
          type: string
          enum:
            - avg
            - min
            - max
            - sum
            - last
            - count
            - rate
            - increase
        match:
          type: array
          maxItems: 40
          items:
            type: string
          description: >-
            Filtros de etiqueta (label=value, label!=value, label=~regex,
            label!~regex). El ámbito del inquilino siempre se aplica de forma
            independiente.
        by:
          type: array
          maxItems: 10
          items:
            type: string
          description: >-
            Etiquetas de agrupación; las series resultantes se suman para
            coincidir con la tarjeta de métrica de la consola.
  responses:
    BadRequest:
      description: Parámetros de solicitud no válidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Unauthorized:
      description: Se requiere autenticación o el token no es válido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permisos insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: No se encontró el recurso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Conflict:
      description: Conflicto de recursos (por ejemplo, ya existe, estado no válido)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: Resource with this name already exists
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Error interno del servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.