Sign Up

Volumes

POST
/volumes/{volumeId}/pull

Pull remote changes into an attached volume. Retain requestId across retries. Definitive results replay within the current session. A pending, unavailable or rate-limited result is retried only by a call with waitMs above zero; waitMs 0 returns the last outcome (a rate limit with its remaining delay) without retrying. An elapsed wait or disconnected caller does not cancel accepted work. A volume not attached to this sandbox returns a conflict. Replay is available only within the current session.

Path Parameters

volumeId*string

Attached volume ID: the volume's vol_ ID or its UUID (1–128 ASCII letters, digits, underscores or hyphens).

Request Body

application/json
  1. body
requestId*string

Caller-generated identity, retained across retries (1–128 ASCII letters, digits, underscores or hyphens). Replay is scoped to the active session.

Match^[A-Za-z0-9_-]+$
Length1 <= length <= 128
waitMs?integer

Maximum HTTP wait in milliseconds. Expiry does not cancel accepted work. Omitted means 30000. Zero submits a new request or retrieves a known one without retrying it; only a wait above zero retries a retryable result.

Formatint64
Range0 <= value <= 30000
Default30000

Response Body

Pulled or unchanged.

application/json
  1. response
manifestId*|

Version of remote volume data applied by a successful pull or observed when unchanged; null when unavailable or pending. An unchanged remote version does not guarantee that local files are unchanged.

requestId*string

The caller's stable request identity, including on elapsed waits.

status*PullVolumeStatus
Value in"pulled""unchanged""pending"
curl -X POST 'http://sandbox:2280/volumes/string/pull' \  -H 'Content-Type: application/json' \  -d '{  "requestId": "string"}'
{  "manifestId": "string",  "requestId": "string",  "status": "pulled"}