> ## 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 sandbox-enabled regions

> Returns regions where sandboxes can be provisioned.



## OpenAPI

````yaml /api-reference/sandboxes.openapi.yaml get /sandboxes/regions
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/regions:
    get:
      tags:
        - Sandboxes
      summary: List sandbox-enabled regions
      description: Returns regions where sandboxes can be provisioned.
      operationId: listSandboxRegions
      responses:
        '200':
          description: Available sandbox regions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxRegionsEnvelope'
components:
  schemas:
    SandboxRegionsEnvelope:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
        data:
          type: object
          required:
            - regions
          properties:
            regions:
              type: array
              items:
                $ref: '#/components/schemas/SandboxRegion'
    SandboxRegion:
      type: object
      required:
        - id
        - name
        - country
        - continent
        - enabled
        - type
      properties:
        id:
          type: string
          example: 6a06df21cc6bef51342e199e
        name:
          type: string
          example: eu-west
        country:
          type: string
          example: France
        continent:
          type: string
          example: Europe
        enabled:
          type: boolean
          description: Whether the region is currently accepting new sandboxes.
        type:
          type: string
          enum:
            - sandbox
          description: Region kind. Sandbox endpoints only return sandbox-eligible regions.
  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.

````