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

# Verificar a presença de telemetria retida

> Requer telemetria: GetTraceSettings. Relata a presença física de logs de conta, intervalos, métricas e agregados de retenção nessa região, incluindo linhas expiradas aguardando recuperação. Não retorna cargas de registro ou ignora TTLs.


<Info>
  Requer a ação do IAM **`telemetry:GetTraceSettings`**. 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/trace-settings/retained-data
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/trace-settings/retained-data:
    get:
      tags:
        - Telemetry
      summary: Verificar a presença de telemetria retida
      description: >
        Requer telemetria: GetTraceSettings. Relata a presença física de logs de
        conta, intervalos, métricas e agregados de retenção nessa região,
        incluindo linhas expiradas aguardando recuperação. Não retorna cargas de
        registro ou ignora TTLs.
      operationId: getRetainedTelemetryPresence
      responses:
        '200':
          description: Presença atual de dados retidos
          content:
            application/json:
              schema:
                type: object
                required:
                  - has_resources
                properties:
                  has_resources:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    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
  schemas:
    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
  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.