> ## 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 grupos de log (ou procure um por nome)

> Sem `name`: retorna os grupos de log da conta, mais recente primeiro, paginado por conjunto de chaves. Com `name`: retorna no máximo um grupo de logs correspondente a esse nome exato (lista vazia se não houver correspondência). Requer `telemetry:DescribeLogGroups`.


<Info>
  Requer a ação do IAM **`telemetry:DescribeLogGroups`**. Consulte [permissões de telemetria](/telemetry/permissions) para obter a lista completa, o que cada uma abrange e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/telemetry.yaml get /v1/log-groups
openapi: 3.0.3
info:
  title: API de Telemetria Basaltica
  version: 1.0.0
  description: >
    API de telemetria regional — grupos de log + ingestão/pesquisa de log,
    métricas do ClickHouse (remote_write + consulta estruturada com envelopes
    JSON compatíveis com Prometheus), ingestão de intervalo e configurações de
    pesquisa/detalhes de rastreamento + rastreamento por conta.


    As referências de solicitação de grupo de log aceitam UUIDs, CRNs ou nomes
    exatos de escopo de conta, classificados por sintaxe sem fallback de
    pesquisa. Os CRNs devem corresponder ao identificador de conta autenticado e
    à região de atendimento. Os logs HTTP e gRPC OTLP usam basaltic.log_group,
    voltando para service.name, com o mesmo contrato de referência.
    Identificadores de rastreamento/espaço, rótulos de métrica e dimensões de
    pesquisa de região são valores de protocolo, independentes da resolução do
    recurso.
  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 (um por região)
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/log-groups:
    get:
      tags:
        - Telemetry
      summary: Listar grupos de log (ou procure um por nome)
      description: >
        Sem `name`: retorna os grupos de log da conta, mais recente primeiro,
        paginado por conjunto de chaves. Com `name`: retorna no máximo um grupo
        de logs correspondente a esse nome exato (lista vazia se não houver
        correspondência). Requer `telemetry:DescribeLogGroups`.
      operationId: listLogGroups
      parameters:
        - name: name
          in: query
          description: Filtro de nome exato, intersetado com crn e paginação.
          schema:
            type: string
            example: app/prod/api
        - name: crn
          in: query
          description: >-
            Filtro CRN de telemetria/log-group exato na conta autenticada e na
            região de atendimento. CRNs malformados ou vazios retornam 400. CRNs
            estrangeiros válidos ou não correspondidos retornam uma página
            vazia. Interseccionado com nome e paginação.
          schema:
            type: string
            example: crn:telemetry:sa-saopaulo-1:my-account:log-group/app/prod/api
        - $ref: '#/components/parameters/LimitDefault50'
        - $ref: '#/components/parameters/Marker'
      responses:
        '200':
          description: Página de grupos de log
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogGroupListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    LimitDefault50:
      name: limit
      in: query
      description: >-
        Número máximo de itens a devolver. Um valor acima do máximo é fixado ao
        invés de rejeitado, então uma página mais curta do que a que você pediu
        é normal — page until `meta.has_more` é false, não até que uma página
        pareça curta.
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      example: 50
    Marker:
      name: marker
      in: query
      description: >-
        Cursor de paginação opaco. Echo back o valor `meta.marker` da página
        anterior para buscar a próxima; não construa ou analise-o. A forma
        interna do token varia de acordo com o endpoint (um ID de recurso, um
        carimbo de data/hora, etc.) e não é garantida a estabilidade entre
        versões.
      required: false
      schema:
        type: string
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    LogGroupListResponse:
      type: object
      properties:
        log_groups:
          type: array
          items:
            $ref: '#/components/schemas/LogGroup'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    LogGroup:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 4a7b2c8d-9e1f-4a2b-8c3d-5e6f7a8b9c0d
        crn:
          type: string
          description: CRN do grupo de log (usado como o recurso IAM ARN)
          example: crn:telemetry:sa-saopaulo-1:my-account:log-group/app-prod-api
        account_id:
          type: string
          format: uuid
          description: Conta de proprietário — a cerca de locatário para este grupo
          example: 9b2e4d11-6c3a-4f8e-bd47-1a2b3c4d5e6f
        name:
          type: string
          description: >-
            1..512 caracteres, [A-Za-z0-9_./#-]. Não é permitido o caractere "/"
            à frente. Os nomes de recursos não devem começar com o prefixo
            literal crn: ou ser UUIDs (formas canônicas, compactas, entre
            colchetes ou urn:uuid:, em qualquer caso).
          example: app/prod/api
        description:
          type: string
          example: Production API request logs
        retention_days:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3650
          description: 1..3650 dias, ou null para nunca expirar
          example: 30
        kms_key_unavailable:
          type: boolean
          readOnly: true
          description: >-
            Verdadeiro quando a chave vinculada foi excluída. O CRN é omitido,
            mas a ligação permanece criptografada sob sua identidade de chave
            original; isso não seleciona criptografia de plataforma ou texto sem
            formatação.
        kms_key_crn:
          type: string
          description: >-
            CRN da chave KMS. Omitida para texto simples ou quando
            kms_key_unavailable é verdadeiro.
          example: crn:kms:sa-saopaulo-1:my-account:key/service-key
        tags:
          type: object
          additionalProperties:
            type: string
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    BadRequest:
      description: Parâmetros de solicitação invá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: Autenticação necessária ou token invá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: Permissões 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
    InternalServerError:
      description: Erro interno do 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: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

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


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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