Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Hiloop API key sent as an HTTP Bearer token.

Headers

idempotency-key
string

Optional idempotency key for this mutation. The server records the result from execution start. For at least 72 hours, reuse by the same organization and route replays the original status and body. A matching request still in flight or reuse for different input returns 409 idempotency_conflict. Keys are scoped by organization and route and contain 1-255 characters.

Required string length: 1 - 255

Path Parameters

id
string
required

The sandbox to snapshot.

Body

application/json
name
string

Optional human-readable snapshot name used by list filtering, from 1 through 128 characters.

Required string length: 1 - 128
wait_remote
boolean
default:false

When true, wait for confirmed remote replication before returning the receipt. When false, return after the local storage snapshot exists. The wait is bounded by wait_timeout_seconds.

wait_timeout_seconds
integer<uint32>

Remote-replication wait bound in seconds, from 1 through 25. At the deadline, return the same snapshot id with truthful local durability rather than holding the request longer.

Required range: 1 <= x <= 25

Response

OK

snapshot_id
string
required

The new immutable snapshot id.

durability
enum<string>
required

Durability proven before this receipt was returned.

Available options:
local,
replicated