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

# Criar snapshot

> Tire um instantâneo de um volume em um determinado momento. A linha é persistente no status `creating` e o snapshot é provisionado de forma assíncrona; poll GET até que o status mude para `available` (sucesso) ou `error`. Permitido contra volumes em `available` ou `in_use` (volumes em uso podem ser instantâneos).


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


## OpenAPI

````yaml /pt/api-reference/specs/storage.yaml post /v1/snapshots
openapi: 3.0.3
info:
  title: API de armazenamento Basaltic
  version: 1.0.0
  description: >
    As referências de armazenamento aceitam UUIDs, CRNs ou nomes de escopo em um
    campo. Os nomes de snapshot requerem um volume fixo; source_snapshot aceita
    somente UUID ou CRN aninhado. Bloqueie volumes com seus snapshots e
    políticas de snapshot, além de gerenciamento de bucket para armazenamento de
    objetos. O próprio protocolo de fio S3 é servido separadamente em
    `objects.{region}.basaltic.cloud`.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://storage.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/snapshots:
    post:
      tags:
        - Storage
      summary: Criar snapshot
      description: >
        Tire um instantâneo de um volume em um determinado momento. A linha é
        persistente no status `creating` e o snapshot é provisionado de forma
        assíncrona; poll GET até que o status mude para `available` (sucesso) ou
        `error`. Permitido contra volumes em `available` ou `in_use` (volumes em
        uso podem ser instantâneos).
      operationId: createSnapshot
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotCreateRequest'
      responses:
        '202':
          description: Criação de snapshot aceita (status=creating)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >
            O volume de origem não está em um estado com permissão de
            instantâneo ou um instantâneo com esse nome já existe para o volume.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    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:
    SnapshotCreateRequest:
      type: object
      additionalProperties: false
      required:
        - volume
        - name
      properties:
        volume:
          description: UUID, CRN ou nome exato do volume de propriedade da conta.
          type: string
          example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
        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
          minLength: 1
          maxLength: 128
          example: nightly-2026-01-15
        description:
          type: string
          example: Nightly backup of data-vol-01
        tags:
          $ref: '#/components/schemas/Tags'
    SnapshotResponse:
      type: object
      properties:
        snapshot:
          $ref: '#/components/schemas/Snapshot'
    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
    Snapshot:
      type: object
      required:
        - faults
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 7b1e9c4d-3a2f-4b8c-9d6e-0f1a2b3c4d5e
        crn:
          type: string
          readOnly: true
          description: Nome do recurso da nuvem (baseado em nome, com escopo de região).
          example: >-
            crn:storage:sa-saopaulo-1:my-account:volume/data-vol-01/snapshot/weekly-backup
        volume_id:
          type: string
          format: uuid
          description: Volume de origem do qual o instantâneo foi tirado.
          example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
        snapshot_policy_id:
          type: string
          format: uuid
          readOnly: true
          description: >
            A política de instantâneo que tirou esse instantâneo. Ausente quando
            uma pessoa fez. Isso também é o que a retenção corresponde, então
            sua presença é o que torna um snapshot elegível para exclusão
            automática — snapshots feitos manualmente nunca são colhidos.
          example: 3c9f1b2e-6d4a-4e8b-9f1c-2a3b4c5d6e7f
        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
          maxLength: 128
          example: nightly-2026-01-15
        description:
          type: string
          example: Nightly backup of data-vol-01
        tags:
          $ref: '#/components/schemas/Tags'
        size_gb:
          type: integer
          description: >
            Tamanho congelado do volume de origem no momento em que o
            instantâneo foi tirado — o volume pode ter sido estendido desde
            então.
          example: 100
        status:
          $ref: '#/components/schemas/SnapshotStatus'
        faults:
          type: array
          readOnly: true
          description: >-
            Falhas ativas, mais recentes primeiro. Vazio quando saudável. Status
            é erro se e somente se uma falha de gravidade de erro ativo existe.
            O histórico resolvido é mantido internamente.
          items:
            $ref: '#/components/schemas/Fault'
        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:42Z'
    SnapshotStatus:
      type: string
      enum:
        - creating
        - available
        - deleting
        - error
      example: available
    Fault:
      type: object
      required:
        - code
        - severity
        - message
        - details
        - first_at
        - last_at
        - occurrences
      properties:
        code:
          type: string
          description: >-
            Código estável legível por máquina pertencente à operação de
            relatório.
          example: BACKUP_FAILED
        severity:
          type: string
          enum:
            - error
            - warning
        message:
          type: string
          example: Backup upload failed.
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexto estruturado; cadeias de caracteres legadas são preservadas
            em legacy_text.
        first_at:
          type: string
          format: date-time
          description: Primeira observação nesta série de ocorrências ativas.
        last_at:
          type: string
          format: date-time
          description: Última observação nesta série de ocorrências ativas.
        occurrences:
          type: integer
          minimum: 1
          example: 1
  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
    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.