Volume

Fields

Field	Type	Description
id *	string
environment_id *	string
name *	string
service_id	string or null
mount_path	string or null
size_gb *	integer
used_bytes	integer
used_percent	number
ha *	boolean
status *	VolumeStatus
resilience_note	string	Read-only.
backups	object
managed_by_manifest	boolean
created_at *	string (date-time)

* always present

Example

{
  "id": "vol_01jbx2m9k7q4r8t5v6w3y0z1vl",
  "environment_id": "env_01jbx2m9k7q4r8t5v6w3y0z1en",
  "name": "rota-cache",
  "service_id": "svc_01jbx2m9k7q4r8t5v6w3y0z1rw",
  "mount_path": "/data",
  "size_gb": 5,
  "used_bytes": 734003200,
  "used_percent": 13.7,
  "ha": false,
  "status": "attached",
  "resilience_note": "This volume is on one server. Turn on HA for automatic failover.",
  "backups": {
    "last_snapshot_at": "2026-10-23T14:00:00Z",
    "last_offsite_at": "2026-10-23T03:00:00Z"
  },
  "managed_by_manifest": true,
  "created_at": "2026-10-22T09:30:00Z"
}

Used by

• Get a volume