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

> Lista os registros em uma zona DNS, newest-RRset-first. Suporta filtragem por `type` e uma correspondência exata em `name`. Keyset- paginated by record id (UUIDv7) — passa o último id da página anterior como `marker`.

**Retorna apenas seus registros.** As linhas que a plataforma carimba para si mesma — o SOA, o NS de ápice e o conjunto DNSSEC (`DNSKEY`, `DS`, `NSEC`/`NSEC3`, `NSEC3PARAM`, `RRSIG`, `CDS`, `CDNSKEY`) — são omitidas, a menos que você as solicite. Em uma zona assinada, eles superam em número os registros de clientes, nenhum deles pode ser editado ou excluído, e o material DNSSEC que você pode realmente querer está na própria zona sob `dnssec`.

Passe `include_managed=true` para obter a zona exatamente como ela é servida, que é o que uma ferramenta de diffing de zona quer.


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


## OpenAPI

````yaml /pt/api-reference/specs/dns.yaml get /v1/zones/{zone_id}/records
openapi: 3.0.3
info:
  title: API de DNS Basaltic
  version: 1.0.0
  description: >
    Zonas hospedadas autoritativas e seus registros, assinados com DNSSEC. Uma
    zona só é servida quando sua propriedade é verificada; associar uma zona a
    uma VPC torna-a resolvível de forma privada dentro dessa rede.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://dns.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/zones/{zone_id}/records:
    get:
      tags:
        - DNS
      summary: Listar registros
      description: >
        Lista os registros em uma zona DNS, newest-RRset-first. Suporta
        filtragem por `type` e uma correspondência exata em `name`. Keyset-
        paginated by record id (UUIDv7) — passa o último id da página anterior
        como `marker`.


        **Retorna apenas seus registros.** As linhas que a plataforma carimba
        para si mesma — o SOA, o NS de ápice e o conjunto DNSSEC (`DNSKEY`,
        `DS`, `NSEC`/`NSEC3`, `NSEC3PARAM`, `RRSIG`, `CDS`, `CDNSKEY`) — são
        omitidas, a menos que você as solicite. Em uma zona assinada, eles
        superam em número os registros de clientes, nenhum deles pode ser
        editado ou excluído, e o material DNSSEC que você pode realmente querer
        está na própria zona sob `dnssec`.


        Passe `include_managed=true` para obter a zona exatamente como ela é
        servida, que é o que uma ferramenta de diffing de zona quer.
      operationId: listRecords
      parameters:
        - $ref: '#/components/parameters/ZoneId'
        - name: type
          in: query
          schema:
            type: string
            example: A
          description: Tipo de registro exato para filtrar (por ex. `A`, `MX`).
        - name: name
          in: query
          schema:
            type: string
            example: www.example.com
          description: >-
            Nome exato do registro, em minúsculas com um ponto final opcional
            removido.
        - name: crn
          in: query
          schema:
            type: string
          description: >-
            Exato CRN de registro aninhado. CRNs estrangeiros ou não
            correspondidos retornam uma página vazia; combinado com o nome antes
            da paginação.
        - name: include_managed
          in: query
          schema:
            type: boolean
            default: false
            example: false
          description: >
            Inclua as linhas com carimbo de plataforma (SOA, NS de ápice e o
            conjunto DNSSEC) ao lado das suas próprias. Desligado por padrão —
            eles não podem ser editados ou excluídos, e em uma zona assinada há
            mais deles do que há de você.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
            example: 50
        - name: marker
          in: query
          schema:
            type: string
            format: uuid
            example: 550e8400-e29b-41d4-a716-446655440000
          description: Token de continuação — o último id de registro da página anterior.
      responses:
        '200':
          description: Lista de registros
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    ZoneId:
      name: zone_id
      in: path
      description: ID da zona DNS
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    RecordListResponse:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/Record'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Record:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 550e8400-e29b-41d4-a716-446655440000
        crn:
          type: string
          readOnly: true
          description: Nome do recurso da nuvem.
          example: >-
            crn:dns::my-account:zone/example.com/record/550e8400-e29b-41d4-a716-446655440000
        zone_id:
          type: string
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440001
        name:
          type: string
          description: Nome do registro (FQDN).
          example: www.example.com
        type:
          type: string
          description: >
            Tipo de registro. Os registros de clientes usam um dos valores de
            RecordType que podem ser criados; as leituras também mostram os
            tipos apex/DNSSEC gerenciados pela plataforma (SOA, NS, DNSKEY, DS,
            NSEC, RRSIG).
          example: A
        ttl:
          type: integer
          minimum: 0
          example: 300
        managed:
          type: boolean
          readOnly: true
          description: >
            Verdadeiro para registros gerenciados pela plataforma (SOA, NS de
            ápice e o conjunto DNSSEC). Os registros gerenciados são somente de
            leitura — eles não podem ser atualizados ou excluídos por meio da
            API.
          example: false
        values:
          type: array
          items:
            $ref: '#/components/schemas/RecordValue'
          minItems: 1
          example:
            - content: 203.0.113.10
              disabled: false
            - content: 203.0.113.11
              disabled: false
    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
    RecordValue:
      type: object
      required:
        - content
      properties:
        content:
          type: string
          description: RDATA — representação de fio por tipo de registro.
          example: 203.0.113.10
        disabled:
          type: boolean
          default: false
          description: >
            Deve ser `false`. `true` é **refusado**.


            Não há lugar para manter um valor que não é servido, então um valor
            desabilitado costumava ser aceito, ecoado de volta na resposta e, em
            seguida, descartado — o valor em estágio desaparecia na próxima
            leitura, com a gravação tendo relatado sucesso. Recusar é a versão
            honesta.


            O campo permanece no esquema porque o console e a CLI o enviam em
            todos os valores; apenas `true` é rejeitado. Para tirar um valor de
            um RRset, remova-o de `values`.
          example: false
  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
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              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.