> ## 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 chaves KMS

> Lista as chaves KMS de propriedade da conta solicitante, a mais recente primeiro. Paginação por cursor usando o ID da chave (UUIDv7 ordena por tempo de criação) — passa o último id da página anterior como `marker` para buscar o próximo.


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


## OpenAPI

````yaml /pt/api-reference/specs/kms.yaml get /v1/keys
openapi: 3.0.3
info:
  title: API do Basaltic KMS
  version: 1.0.0
  description: >
    Chaves de criptografia gerenciadas pelo cliente. Criptografe e
    descriptografe diretamente ou deixe que outro serviço — segredos,
    armazenamento, imagens — envolva suas chaves de dados com uma das suas.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://kms.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/keys:
    get:
      tags:
        - KMS
      summary: Listar chaves KMS
      description: >
        Lista as chaves KMS de propriedade da conta solicitante, a mais recente
        primeiro. Paginação por cursor usando o ID da chave (UUIDv7 ordena por
        tempo de criação) — passa o último id da página anterior como `marker`
        para buscar o próximo.
      operationId: listKeys
      parameters:
        - 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: 7c9e2f4a-1d83-4b6e-9a2c-5f8b0d3e6a17
          description: Token de continuação — o último id de chave da página anterior.
        - name: state
          in: query
          schema:
            $ref: '#/components/schemas/KeyState'
          description: Filtro de estado opcional (ativado / desativado / pending_deletion).
        - name: name
          in: query
          schema:
            type: string
            example: prod-master
          description: >-
            Nome de chave de escopo de conta exato e sensível a maiúsculas e
            minúsculas. Combinado com outros filtros.
        - name: crn
          in: query
          schema:
            type: string
            example: crn:kms:sa-saopaulo-1:acme:key/prod-master
          description: >-
            CRN exato da chave KMS na conta autenticada e na região atual. CRNs
            mal formados ou vazios retornam 400; CRNs estrangeiros válidos ou
            não correspondidos retornam uma página vazia. Combinado com filtros
            de nome e estado.
      responses:
        '200':
          description: Lista de chaves
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    KeyState:
      type: string
      enum:
        - enabled
        - disabled
        - pending_deletion
      description: |
        Estado do ciclo de vida:
          - enabled: utilizável para operações de spec/usage
          - disabled: existe; recusa cripto operações; pode ser reativado
          - pending_deletion: agendado para exclusão em scheduled_purge_at; cancelável até então
      example: enabled
    KeyListResponse:
      type: object
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/Key'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Key:
      type: object
      required:
        - id
        - crn
        - name
        - key_spec
        - key_usage
        - state
        - tags
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 3f8a1c2e-9b47-4d6a-bc11-0e2f5a7d9c41
        crn:
          type: string
          readOnly: true
          example: crn:kms:sa-saopaulo-1:my-account:key/prod-master
        name:
          description: >-
            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).
          type: string
          example: prod-master
        description:
          type: string
          example: Master KEK for the production data plane
        tags:
          $ref: '#/components/schemas/Tags'
        key_spec:
          $ref: '#/components/schemas/KeySpec'
        key_usage:
          $ref: '#/components/schemas/KeyUsage'
        state:
          $ref: '#/components/schemas/KeyState'
        system:
          type: boolean
          readOnly: true
          example: true
          description: >
            Presente e verdadeiro em chaves de envelope de propriedade da
            plataforma (mestre de credenciais, signatário JWT, …), que são
            visíveis, mas não são suas para operar. Omitida nas chaves do
            cliente. Console e CLI lêem-no para esconder as ações destrutivas.
        deleted_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando a exclusão foi solicitada. Nulo para chaves ativas e
            exclusões pendentes históricas cujo tempo de solicitação é
            desconhecido.
        recovery_window_days:
          type: integer
          nullable: true
          minimum: 7
          maximum: 30
          description: >-
            Janela de dia inteiro escolhida. Nulo para chaves ativas e exclusões
            pendentes históricas cuja janela é desconhecida.
        scheduled_purge_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-22T09:30:00Z'
          description: >
            Definido somente enquanto state=pending_deletion. A chave (e seu
            material criptográfico) é excluída quando now() atinge esse
            timestamp; CancelKeyDeletion antes disso retorna a chave para
            state=disabled.
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          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
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    KeySpec:
      type: string
      enum:
        - aes-256
        - rsa-2048
        - rsa-4096
        - ecdsa-p256
      description: |
        Especificação criptográfica. Determina quais mecanismos se aplicam:
          - aes-256: AEAD simétrico (AES-GCM)
          - rsa-2048: assimétrico; criptografia OAEP-SHA256 + sinal PSS-SHA256
          - rsa-4096: mesmo que rsa-2048
          - ecdsa-p256: assimétrico; assinatura/verificação SHA-256 (sem criptografia)
      example: aes-256
    KeyUsage:
      type: string
      enum:
        - encrypt_decrypt
        - sign_verify
      description: >
        Operação definida para a qual a chave é fixada no momento da criação.
        Mesmo quando a especificação suporta ambos (RSA), um uso deve ser
        escolhido — o serviço recusa operações do outro conjunto.
      example: encrypt_decrypt
  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
  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.