Skip to main content
POST
Create a sandbox snapshot

Authorizations

x-brimble-key
string
header
required

API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$

Body

application/json
name
string
required

Lowercase letters, numbers and dashes.

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

Response

Snapshot creation started

message
string
required
Example:

"Snapshot creation started"

data
object
required
Last modified on October 10, 2026