Skip to main content
POST
Create a sandbox

Authorizations

Authorization
string
header
required

API Key or Access Token, always sent as Authorization: Bearer <token>. The gateway recognizes the token type automatically.

Headers

Idempotency-Key
string

Optional caller-generated idempotency key (a UUID is recommended). Matched byte-for-byte: 1-64 printable ASCII characters, no whitespace. Absent means no deduplication. The same key with a different request body returns 400 Sandbox.IdempotentParameterMismatch. Echoed on responses; replays add Idempotency-Replayed: true. Keys are remembered for 24 hours.

Required string length: 1 - 64

Body

application/json
template_id
string
required

Template identifier or name. A snapshot-as-template snapshotID is also valid here.

idc_name
string

Target data center name, e.g. us-central1-c. Optional: when omitted, the organization's configured default data center is used (maintained by the platform administrator); if the organization has no default configured, the request returns 400. Note that Templates are bound to a data center: the effective data center (whether explicit or default) must match the one that owns the Template referenced by template_id, otherwise the request is treated as template-not-found.

timeout
integer<int64>

Time-to-live in seconds. When omitted or 0 or less, 300 seconds is used.

env_vars
object
metadata
object

Customer-defined key/value pairs; the platform does not interpret them. The list endpoint can filter by them.

Response

Sandbox created

request_id
string
required

Request tracing ID

data
object
required