Skip to main content
POST
Create a durable snapshot

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
sandbox_id
string<uuid>
required
name
string

Customer-defined name. Leading and trailing whitespace is removed; whitespace-only names become empty. Non-empty names are unique within the organization across all IDCs; conflicts return 409 Resource.AlreadyExists. Creation failure clears the name.

Maximum string length: 255
metadata
object

Response

Snapshot record is addressable; status may be creating, ready, or error.

request_id
string
required
data
object
required