Volume
A persistent disk in an environment — created implicitly when a service enables volume, then managed by id (grow, snapshot, detach, re-attach; delete when detached).
Attributes
VolumeDtoA persistent disk in an environment — created implicitly when a service enables `volume`, then managed by id (grow, snapshot, detach, re-attach; delete when detached).
idstringread-only
environmentIdstringread-only
The environment this volume belongs to.
serviceIdstring | nullread-only
The service mounting this volume; null when detached (an orphan).
namestringread-only
Volume name, unique within the environment.
mountPathstringread-only
Path the volume is mounted at when attached.
sizeGbintegerread-only
Current volume size in GB.
statusobjectread-only
Read-only: live disk state (provisioning/ready, actual size, usage).
createdAtstring <date-time>read-only
updatedAtstring <date-time>read-only
The Volume object
json
{ "id": "vol_01example0000000000000000x", "environmentId": "env_01example0000000000000000x", "serviceId": "svc_01example0000000000000000x", "name": "my-app", "mountPath": "example", "sizeGb": 0, "status": { "state": "ready", "location": "example", "currentSizeGb": 1, "usedBytes": 1, "commands": [ { "id": "vol_01example0000000000000000x", "kind": "expand", "status": "running", "startedAt": "2026-01-01T00:00:00.000Z", "completedAt": "2026-01-01T00:00:00.000Z", "error": "example", "detail": "example" } ] }, "createdAt": "2026-01-01T00:00:00.000Z", "updatedAt": "2026-01-01T00:00:00.000Z"}