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

# List available sandbox templates

> Returns the templates registered in `SandboxImage`. Pass `name` back as
the `template` field on `POST /sandboxes`. If no template is sent on
create, the server's configured default is used.




## OpenAPI

````yaml GET /sandbox/templates
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:
  /sandbox/templates:
    get:
      tags:
        - Sandboxes
      summary: List available sandbox templates
      description: |
        Returns the templates registered in `SandboxImage`. Pass `name` back as
        the `template` field on `POST /sandboxes`. If no template is sent on
        create, the server's configured default is used.
      operationId: listSandboxTemplates
      responses:
        '200':
          description: Templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxTemplatesEnvelope'
components:
  schemas:
    SandboxTemplatesEnvelope:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Templates fetched
        data:
          type: array
          items:
            $ref: '#/components/schemas/SandboxTemplate'
    SandboxTemplate:
      type: object
      required:
        - name
        - display_name
        - description
      properties:
        name:
          type: string
          description: >-
            Identifier to pass as `template` on sandbox create (e.g. `node-22`,
            `python-3.12`).
        display_name:
          type: string
          description: Human-readable label for the picker UI.
        description:
          type: string
  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.

````