API reference · Schema
Volume
objectstringrequiredAlways `volume`: the type of this object
One of
volumeidstringrequiredUnique ID (`vol_…`)
ID with prefix vol_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
project_idstringrequiredProject it belongs to
ID with prefix prj_
namestringrequiredIts name
kindstringrequired`pod`: one pod’s own volume (exclusive). `network`: standalone, mountable by several pods at once. `cluster`: a cluster’s shared volume (deleted with the cluster).
One of
podnetworkclustersize_gbintegerrequiredSize in GB; storage is billed on this size
regionstringrequiredRegion code
statusstringrequired`creating`: being set up. `ready`: usable. `deleting`: deleted and billing stopped; its host is removing the data. `deleted`: the data is gone.
One of
creatingreadydeletingdeletedpinned_to_hostbooleanrequiredVolumes live on one host until shared storage exists. Once a pod has mounted it, the volume is pinned to that host, and every pod that mounts it (now or later) runs on that host — waiting for capacity there if it is full.
owner_pod_idstring | nullrequiredID of the owner pod
usageobject | nullrequiredSpace used against the size, as last measured by the host it lives on (while a pod or worker mounts it); null until then
ShowHide 3 fields of
usageused_bytesintegerrequiredSpace used on its host
size_bytesintegerrequiredThe size, enforced on the host: writes beyond it fail
observed_atstring (date-time)requiredWhen it was measured
attachmentsarray of objectrequiredPods whose configuration mounts the volume
ShowHide 3 fields of
attachmentspod_idstringrequiredID of the pod
mount_pathstringrequiredAbsolute path the volume is mounted at inside the container
read_onlybooleanrequiredMounted read-only in that pod
endpoint_attachmentsarray of objectrequiredServerless endpoints whose current release mounts the volume, or that still have a worker mounting it. While any is listed the volume cannot be deleted.
ShowHide 3 fields of
endpoint_attachmentsendpoint_idstringrequiredThe serverless endpoint
mount_pathstringrequiredWhere its workers see the volume
read_onlybooleanrequiredMounted read-only in its workers
billingobjectrequiredHow the volume’s storage is charged
ShowHide 3 fields of
billingmeterstringrequiredUnit of use: GB of size per second, from creation to deletion
One of
storage_gb_secondprice_keystringrequiredPrice list entry the storage is charged at: `pod_volume` or `network_volume`
billed_untilstring (date-time) | nullrequiredStorage is billed from creation to deletion, attached or not
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
deleted_atstring (date-time) | nullrequiredWhen it was deleted (null while it exists) (ISO 8601, UTC)
{
"object": "volume",
"id": "vol_01jc5zq4m8k3v6x9t2w7r0b1e4",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
"name": "string",
"kind": "pod",
"size_gb": 1,
"region": "string",
"status": "creating",
"pinned_to_host": true,
"owner_pod_id": "string",
"usage": {
"used_bytes": 1,
"size_bytes": 1,
"observed_at": "2026-01-01T00:00:00.000Z"
},
"attachments": [
{
"pod_id": "string",
"mount_path": "string",
"read_only": true
}
],
"endpoint_attachments": [
{
"endpoint_id": "string",
"mount_path": "string",
"read_only": true
}
],
"billing": {
"meter": "storage_gb_second",
"price_key": "string",
"billed_until": "2026-01-01T00:00:00.000Z"
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"deleted_at": "2026-01-01T00:00:00.000Z"
}Used by
- List live volumes in the project
GET /v1/volumes - Create a network volume (billed per GB-second until deleted)
POST /v1/volumes - Get a volume, where it is pinned and which pods mount it
GET /v1/volumes/{volume_id} - Rename a volume
PATCH /v1/volumes/{volume_id} - Delete an unattached volume and its data (irreversible; billing stops now)
DELETE /v1/volumes/{volume_id} - Grow a volume (sizes never shrink)
POST /v1/volumes/{volume_id}/grow