Skip to main content
POST
Sync Volume Endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sandbox_id
string
required
name
string
required

Body

application/json

Body of POST /api/v1/sandbox/{sandbox_id}/volumes/{name}/sync.

discard
boolean
default:false

Drop this sandbox's unpublished volume writes and re-attach at the committed head without publishing.

Response

Successful Response

One attachment's sync state machine row.

state is null before the first sync; head_id is the attachment's current head (the synced head once state is DONE); updated_at is the last transition time. failure says why the sync failed (BUSY, PUBLISH_FAILED, MERGE_FAILED, DEADLINE, NODE_ERROR or ROLLBACK_FAILED); it is set from the moment the sync starts rolling back and stays set when the sandbox itself leaves RUNNING mid-rollback.

sync_id
string | null
state
string | null
head_id
string | null
updated_at
string<date-time> | null
failure
string | null