Skip to main content
POST
/
sandboxes
/
{id}
/
snapshots
Create a snapshot
curl --request POST \
  --url https://sandbox.brimble.io/sandboxes/{id}/snapshots \
  --header 'Content-Type: application/json' \
  --header 'x-brimble-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "message": "Snapshot creation started",
  "data": {
    "id": "<string>",
    "sandbox_id": "<string>",
    "name": "<string>",
    "image_tag": "<string>",
    "source_template": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "failure_reason": "<string>",
    "size_bytes": 123
  }
}

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}$

Body

application/json
​
name
string
required

Lowercase letters, digits, hyphens; 1–40 chars.

Pattern: ^[a-z0-9-]{1,40}$

Response

Snapshot creation started

​
message
string
required
Example:

"Snapshot creation started"

​
data
object
required
Last modified on May 20, 2026