Skip to main content
GET
/
sandboxes
/
{id}
Get a sandbox
curl --request GET \
  --url https://sandbox.brimble.io/sandboxes/{id} \
  --header 'x-brimble-key: <api-key>'
{
  "message": "Sandbox fetched",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "template": "<string>",
    "region": {
      "id": "6a06df21cc6bef51342e199e",
      "name": "eu-west",
      "country": "France",
      "continent": "Europe",
      "enabled": true,
      "type": "sandbox"
    },
    "specs": {
      "cpu": 1000,
      "memory": 1024,
      "disk": 3
    },
    "created_at": "2023-11-07T05:31:56Z",
    "last_activity_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "team": "<string>",
    "project_environment": "<string>",
    "auto_destroy": true,
    "one_shot": true,
    "block_outbound": true,
    "persistent": true,
    "persistent_disk_gb": 123,
    "paused_at": "2023-11-07T05:31:56Z",
    "from_snapshot": "<string>",
    "snapshot_frequency": "<string>",
    "destroyed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-brimble-key
string
header
required

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.

Path Parameters

id
string
required

24-char hex id of the sandbox.

Pattern: ^[a-f0-9]{24}$

Response

Sandbox detail

message
string
required
Example:

"Sandbox fetched"

data
object
required
Last modified on May 31, 2026