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

# Rotacionar o material da chave agora

> Cria uma nova versão do material mantendo o ID, o CRN, as permissões e o material histórico da chave. Textos cifrados e assinaturas existentes continuam utilizáveis. Envie Idempotency-Key para repetir a solicitação com segurança: o mesmo token nesta chave retorna a mesma rotação durante toda a vida da chave, mesmo após a conclusão. Uma solicitação diferente enquanto há rotação ativa retorna 409. Sem token, cada solicitação cria uma nova intenção. Consulte a rotação pelo ID quando ela for aceita com 202.

<Info>
  Exige a ação IAM **`kms:RotateKeyOnDemand`**. Veja [permissões do KMS](/pt/kms/permissions) para a lista completa, o escopo de cada ação e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/kms.yaml post /v1/keys/{key_id}/rotate
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/{key_id}/rotate:
    parameters:
      - name: key_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - KMS
      summary: Rotacionar o material da chave agora
      description: >-
        Cria uma nova versão do material mantendo o ID, o CRN, as permissões e o
        material histórico da chave. Textos cifrados e assinaturas existentes
        continuam utilizáveis. Envie Idempotency-Key para repetir a solicitação
        com segurança: o mesmo token nesta chave retorna a mesma rotação durante
        toda a vida da chave, mesmo após a conclusão. Uma solicitação diferente
        enquanto há rotação ativa retorna 409. Sem token, cada solicitação cria
        uma nova intenção. Consulte a rotação pelo ID quando ela for aceita com
        202.
      operationId: rotateKeyOnDemand
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 255
          description: >-
            Token durável de solicitação por chave; reutilize-o nas tentativas
            da mesma rotação.
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationResponse'
        '202':
          description: Rotação aceita; consulte seu estado pelo ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyRotationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Chave ou rotação não encontrada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: O estado, o uso da chave ou uma rotação ativa impede esta operação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    KeyRotationResponse:
      type: object
      required:
        - rotation
      properties:
        rotation:
          $ref: '#/components/schemas/KeyRotation'
    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
    KeyRotation:
      type: object
      required:
        - id
        - key_id
        - trigger
        - status
        - previous_version
        - key_version
        - requested_at
        - started_at
        - completed_at
        - error_code
      properties:
        id:
          type: string
          format: uuid
        key_id:
          type: string
          format: uuid
        trigger:
          type: string
          enum:
            - on_demand
            - automatic
        status:
          type: string
          enum:
            - pending
            - in_progress
            - reconciliation_required
            - succeeded
            - failed
          description: >-
            Operações pendentes são duráveis. Reconciliation_required significa
            que o resultado no serviço é desconhecido; nenhuma segunda rotação é
            enviada e novas solicitações ficam bloqueadas até a resolução.
            Failed significa que a solicitação foi cancelada antes do despacho.
        previous_version:
          type: integer
          minimum: 1
          nullable: true
        key_version:
          type: integer
          minimum: 2
          nullable: true
          description: Nova versão do material, preenchida apenas em caso de sucesso.
        requested_at:
          type: string
          format: date-time
        started_at:
          type: string
          format: date-time
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        error_code:
          type: string
          nullable: true
          description: >-
            Motivo de cancelamento ou reconciliação legível por máquina. Nulo em
            caso de sucesso.
  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.