API reference · Schema
AttachVolumeRequest
Mount the volume in a pod. This reconfigures the pod: its container is recreated (only volume data survives) and it may move to the volume’s host.
pod_idstringrequiredID of the pod
ID with prefix pod_
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
2–256 characters
read_onlybooleanMount read-only (network volumes only; a pod volume is always writable)
default false
dry_runbooleanOnly report what would change (nothing is applied)
default false
Example
{
"pod_id": "pod_01jc5zq4m8k3v6x9t2w7r0b1e4",
"mount_path": "/data",
"dry_run": true
}Used by
- Mount the volume in a pod (recreates the pod’s container; see the plan)
POST /v1/volumes/{volume_id}/attach