Skip to main content
GET
/
v1
/
volumes
/
by-name
/
{name}
Get volume metadata by exact name
import requests

url = "https://api.13-215-85-171.sslip.io/v1/volumes/by-name/{name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "id": "<string>",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "used_bytes": 123,
  "inode_count": 123,
  "mount_count": 123,
  "max_size_bytes": 123,
  "max_file_count": 123,
  "max_mounts": 123,
  "last_reconciled_at": "2023-11-07T05:31:56Z",
  "host_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
name
string
required

Exact volume name within the caller tenant scope

Query Parameters

​
fields
string

Comma-separated field mask for volume list/get responses. Supported fields: id, name, created_at, host_id, used_bytes, inode_count, mount_count, max_size_bytes, max_file_count, max_mounts, last_reconciled_at, status.

Response

Volume metadata

​
id
string
required
​
name
string
required
​
created_at
string<date-time>
required
​
used_bytes
integer<int64>
required

Last reconciled observed bytes stored in the volume.

​
inode_count
integer<int64>
required

Last reconciled observed inode count for the volume.

​
mount_count
integer<int32>
required

Current number of active or paused volume mounts tracked by the control plane.

​
max_size_bytes
integer<int64> | null
required

Current enforced storage quota in bytes. In elastic deployments this value can increase automatically up to operator policy limits; it is not a public resize request field.

​
max_file_count
integer<int64> | null
required

Current enforced file-count quota, when configured.

​
max_mounts
integer<int32> | null
required

Current enforced concurrent-mount limit, when configured.

​
last_reconciled_at
string<date-time> | null
required
​
status
enum<string>
required
Available options:
available,
attached,
degraded,
error
​
host_id
string
deprecated

Optional operational diagnostic for legacy clients. Normal public volume responses omit this field; it is not durable volume identity.