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

# Restaurar um segredo a partir da janela de recuperação

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


## OpenAPI

````yaml /pt/api-reference/specs/secrets.yaml post /v1/secrets/{secret_id}/restore
openapi: 3.0.3
info:
  title: Basaltic Secrets API
  version: 1.0.0
  description: >
    As ligações KMS usam `kms_key`: um UUID, nome com escopo de conta ou
    `crn:kms:<region>:<account>:key/<name>` completo na conta autenticada e na
    região atual. A chave deve estar habilitada, simétrica e utilizável para
    criptografia. As ligações retêm a identidade imutável da chave; as respostas
    rendem seu CRN. CRNs inválidos ou de escopo estrangeiro são rejeitados com
    HTTP 400; chaves ausentes retornam HTTP 404 em uso de vinculação ou
    criptográfico. As leituras de metadados permanecem disponíveis para ligações
    excluídas, com kms_key_unavailable true e sem kms_key_crn. Segredos de
    aplicativos com controle de versão com criptografia de envelope com suporte
    a KMS.


    Os segredos são regionais. O valor de cada versão é criptografado em repouso
    sob uma chave KMS — somente o texto cifrado opaco é mantido. Por padrão, um
    segredo usa a chave gerenciada pela plataforma; passe kms_key em
    CreateSecret para vinculá-lo a uma de suas próprias chaves KMS (a chave é
    fixada para a vida do segredo e cada versão é criptografada sob ela). Cada
    PutSecretValue aloca um novo número de versão monotonicamente crescente e
    inverte is_current na linha anterior; versões mais antigas permanecem
    legíveis por consulta de versão explícita.


    Soft delete: DeleteSecret move o segredo para uma janela de recuperação
    (padrão 7 dias, configurável 1-30). RestoreSecret sai da janela. O varredor
    de purga removido remove a linha + cada versão uma vez now() >=
    scheduled_purge_at.


    Os valores se movem na resposta da API como base64 para sobreviver a cargas
    binárias arbitrárias (máximo de 64 KiB para espelhar o AWS Secrets Manager).
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://secrets.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
tags:
  - name: Secrets
    description: Metadados secretos + ciclo de vida de valor
paths:
  /v1/secrets/{secret_id}/restore:
    parameters:
      - $ref: '#/components/parameters/SecretId'
    post:
      tags:
        - Secrets
      summary: Restaurar um segredo a partir da janela de recuperação
      operationId: restoreSecret
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Segredo restaurado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecretResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    SecretId:
      name: secret_id
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: >-
        Chave opcional gerada pelo cliente que torna uma criação segura para
        reprodução. A reintentar uma solicitação com a mesma chave retorna o
        resultado original literalmente em vez de criar um recurso duplicado. A
        reutilização de uma chave com um corpo de solicitação diferente é
        rejeitada (422); uma solicitação cuja chave ainda está sendo processada
        retorna 409. Os registros são honrados por 24 horas. Use um UUID ou
        token exclusivo semelhante.
      required: false
      schema:
        type: string
        maxLength: 255
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    SecretResponse:
      type: object
      required:
        - secret
      properties:
        secret:
          $ref: '#/components/schemas/Secret'
    Secret:
      type: object
      required:
        - id
        - name
        - crn
        - managed
        - recovery_window_days
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
        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/api/stripe-key
        description:
          type: string
          example: Stripe live secret key for the payments service
        tags:
          $ref: '#/components/schemas/Tags'
        crn:
          type: string
          example: crn:secrets:sa-saopaulo-1:my-account:secret/prod/api/stripe-key
        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
          pattern: ^crn:kms:[^:]+:[^:]+:key/[^:]+$
          nullable: true
          description: >-
            Chave KMS gerenciada pelo cliente sob a qual o segredo é
            criptografado. Omitida para criptografia de plataforma ou quando
            kms_key_unavailable é verdadeiro.
          example: crn:kms:sa-saopaulo-1:acme:key/service-key
        managed:
          type: boolean
          readOnly: true
          description: >-
            True quando um serviço de plataforma gerou esse valor e o lê de
            volta para agir. Você pode ler e excluir um segredo gerenciado, mas
            UpdateSecret e PutSecretValue respondem 403 SECRET_PLATFORM_MANAGED.
          example: false
        deleted_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-20T14:05:00Z'
        scheduled_purge_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-01-27T14:05:00Z'
        recovery_window_days:
          type: integer
          minimum: 1
          maximum: 30
          example: 7
          description: Janela de recuperação de dia inteiro.
        current_version:
          type: integer
          description: 0 se nenhuma versão ainda existir.
          example: 3
        created_at:
          type: string
          format: date-time
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-01-18T11:45:00Z'
    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
  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
    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
    Conflict:
      description: Conflito de recursos (por exemplo, já existe, estado inválido)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: CONFLICT
              message: Resource with this name already exists
              request_id: 550e8400-e29b-41d4-a716-446655440000
    UnprocessableEntity:
      description: >
        A solicitação está bem formada, mas não pode ser processada conforme
        enviada. Nas operações que aceitam `Idempotency-Key` este é o caso de
        reutilização de chave: a chave foi vista pela primeira vez com uma carga
        de solicitação diferente, então reproduzir o resultado armazenado
        responderia a uma pergunta que o chamador não fez.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_KEY_REUSED
              message: >-
                This Idempotency-Key was already used with a different request
                payload
              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.