POST /v1/sandboxes/{id}/volumes/{mount}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

{mount} is the URL-encoded absolute mount path (e.g. %2Fdata).

volume*string

read_only?boolean

subdir?string

required?boolean

false: the mount never fails the attach: one that cannot be prepared answers 202 with the mount held. When it cannot be prepared or attached (a sub_path image still being derived or failing, the folder too large, the volume busy, flushing, missing or in another region, the host or guest refusing it), the sandbox boots without it and the mount is held: state "pending" (retried automatically with backoff, 2 s doubling to 5 min) or "failed" (retried when the volume's head or the size cap changes), with code, error and, for sub_path_too_large, bytes and max_bytes. Nothing is left at the mount path until it is mounted. true (the default): any failure fails the request, as always. An exclusive mount is always required.

Defaulttrue

ref?string

Read-only mounts only: a tag or commit id to serve instead of the head.

mount_path?string

The mount path, when {mount} is not one.

share?string

Preview, off unless enabled for the organization. "node" asks for the mount to be served from one shared copy of the volume per compute node; it is a request: when node share cannot serve it, share_fallback decides between running "private" (its own disk) and refusing — see share_effective.

Default"private"

Value in

"node"
"private"

share_fallback?string

What a "node" request does when node share cannot serve it: "refuse" answers 409 share_unavailable (with the reason) and mounts nothing; "private" mounts a private copy and says why in share_fallback_reason. Default: "refuse" when the volume is node-shared anywhere now, otherwise "private"; always "private" while node share is switched off or draining.

Value in

"refuse"
"private"

Response Body

`application/json`

curl -X POST "https://example.com/v1/sandboxes/string/volumes/string" \  -H "Content-Type: application/json" \  -d '{    "volume": "string"  }'

{  "id": "string",  "sandbox_id": "string",  "volume_id": "string",  "volume_name": "string",  "mount_path": "string",  "read_only": true,  "subdir": "string",  "state": "pending",  "generation": 0,  "base_commit_id": "string",  "mounted_commit_id": "string",  "pinned_commit_id": "string",  "last_commit_id": "string",  "last_commit_at": "string",  "dirty_bytes": 0,  "unflushed": true,  "error": "string",  "share": "node",  "share_effective": "node",  "share_fallback_reason": "string",  "stale": true,  "durability": "commit",  "exclusive": true,  "required": true,  "code": "string",  "retry_at": "string",  "attempts": 0,  "bytes": 0,  "max_bytes": 0,  "created_at": "string"}

{  "id": "string",  "sandbox_id": "string",  "volume_id": "string",  "volume_name": "string",  "mount_path": "string",  "read_only": true,  "subdir": "string",  "state": "pending",  "generation": 0,  "base_commit_id": "string",  "mounted_commit_id": "string",  "pinned_commit_id": "string",  "last_commit_id": "string",  "last_commit_at": "string",  "dirty_bytes": 0,  "unflushed": true,  "error": "string",  "share": "node",  "share_effective": "node",  "share_fallback_reason": "string",  "stale": true,  "durability": "commit",  "exclusive": true,  "required": true,  "code": "string",  "retry_at": "string",  "attempts": 0,  "bytes": 0,  "max_bytes": 0,  "created_at": "string"}

Empty

{  "error": "string",  "code": "string",  "limit": "string",  "max": 0,  "used": 0,  "requested": 0,  "reason": "string"}

Authorization

Path Parameters

Request Body

Response Body

201application/json

202application/json

401

409application/json

`application/json`

`application/json`

`application/json`