> ## Documentation Index
> Fetch the complete documentation index at: https://paper.brimble.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a snapshot

> Triggers a snapshot of the sandbox's current state. Sandbox must be `ready`.
Snapshot transitions through `creating` → `ready` (or `failed`); poll
`GET /sandboxes/{id}/snapshots` to see the new status.




## OpenAPI

````yaml POST /sandboxes/{id}/snapshots
openapi: 3.0.3
info:
  title: Brimble Sandbox API
  description: >
    REST API for managing Brimble sandboxes, ephemeral compute environments with

    optional persistent storage. Covers lifecycle (create / pause / resume /
    destroy),

    egress policy, runtime operations (exec, runCode, file upload/download),

    observability (logs, stats), and snapshots.


    ## Conventions


    - **Response envelope:** non-`204` JSON responses use `{ "message": string,
    "data"?: <payload> }`.
      The schemas below describe the **`data`** payload only.
    - **Errors:** every non-2xx response uses `{ "message": string }`. The
    message is
      user-facing.
    - **Async transitions:** pause / resume / destroy return immediately;
      the status change is visible on the next `GET` or in the dashboard.
      **Create is synchronous** — `POST /sandboxes` blocks until `status` is `ready`.
    - **IDs:** every `id` is a 24-char hex string.
  version: 1.0.0
  contact:
    name: Brimble Engineering
    url: https://brimble.io
servers:
  - url: https://sandbox.brimble.io
    description: Production
security:
  - brimbleKey: []
tags:
  - name: Sandboxes
    description: Lifecycle and metadata
  - name: Runtime
    description: Exec, code, files
  - name: Observability
    description: Logs and stats
  - name: Snapshots
    description: Manual & automatic snapshots
  - name: Volumes
    description: >-
      Persistent disks, pre-provisioned independently of sandbox lifecycle, then
      attached to a sandbox or project
paths:
  /sandboxes/{id}/snapshots:
    post:
      tags:
        - Snapshots
      summary: Create a snapshot
      description: >
        Triggers a snapshot of the sandbox's current state. Sandbox must be
        `ready`.

        Snapshot transitions through `creating` → `ready` (or `failed`); poll

        `GET /sandboxes/{id}/snapshots` to see the new status.
      operationId: createSnapshot
      parameters:
        - $ref: '#/components/parameters/SandboxIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSnapshotInput'
      responses:
        '202':
          description: Snapshot creation started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotEnvelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    SandboxIdParam:
      in: path
      name: id
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{24}$
      description: 24-char hex id of the sandbox.
  schemas:
    CreateSnapshotInput:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          pattern: ^[a-z0-9-]{1,40}$
          description: Lowercase letters, digits, hyphens; 1–40 chars.
    SnapshotEnvelope:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Snapshot creation started
        data:
          $ref: '#/components/schemas/Snapshot'
    Snapshot:
      type: object
      required:
        - id
        - sandbox_id
        - name
        - image_tag
        - source_template
        - status
        - created_at
      properties:
        id:
          type: string
        sandbox_id:
          type: string
        name:
          type: string
        image_tag:
          type: string
        source_template:
          type: string
        status:
          type: string
          enum:
            - creating
            - ready
            - failed
        failure_reason:
          type: string
          nullable: true
        size_bytes:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          description: Human-readable, user-facing error reason.
  responses:
    BadRequest:
      description: Validation error / invalid state transition
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidId:
              summary: Invalid sandbox id
              value:
                message: Invalid sandbox id
            statusTransition:
              summary: Wrong status
              value:
                message: Sandbox is paused; only ready sandboxes can be paused
            fileNotDir:
              summary: Parent dir missing on upload
              value:
                message: 'Destination directory does not exist: /work'
            duplicateVolumeName:
              summary: Duplicate volume name
              value:
                message: A volume named "node-cache" already exists
            volumeAttached:
              summary: Delete attempted on attached volume
              value:
                message: Volume is attached; detach it before deleting
    NotFound:
      description: >-
        Sandbox or related resource not found (also returned when owned by
        another user)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            sandboxNotFound:
              value:
                message: Sandbox not found
            snapshotNotFound:
              value:
                message: Snapshot not found
            volumeNotFound:
              value:
                message: Volume not found
  securitySchemes:
    brimbleKey:
      type: apiKey
      in: header
      name: x-brimble-key
      description: |
        Your account-level Brimble API key. Find it in the dashboard under
        your profile drawer → **API key** (click the avatar in the sidebar).
        Available on paid plans only.

````