Skip to main content
POST
Attach a volume to a running machine

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Machine ID (e.g. mch_a1b2c3d4)

Body

application/json

Shared-volume mount request. ref accepts either an exact volume name or a volume id and is resolved server-side.

ref
string
required

Canonical mount selector for machine create. Accepts either an exact volume name or a volume id and is resolved server-side.

mount_path
string
required

Absolute machine mount path for the attached volume. Values are normalized before persistence. / and reserved runtime paths under /workspace/.nullspace are rejected.

subpath
string | null

Optional volume-internal subdirectory. Values are normalized relative to the volume root and may not escape it.

read_only
boolean
default:false

Response

Volume attached

id
string
required
volume_id
string
required
machine_id
string
required
mount_path
string
required

Normalized machine mount path for the attached volume.

read_only
boolean
required
state
enum<string>
required
Available options:
requested,
mounting,
mounted,
paused,
remounting,
unmounted,
releasing,
released,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
subpath
string | null
last_error_code
string | null
last_error_message
string | null