Skip to main content
Get a volume

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

volume_id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$

Response

Volume

A durable folder stored by BoxRouter. Checkpoint and branch operations depend on current capability admission. Its backend is internal.

id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$
name
string
required
Required string length: 1 - 63
Pattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
state
enum<string>
required

A deleting volume remains visible in GET and list results until remote removal is confirmed; after deletion GET returns 404 and the volume is omitted from list results.

Available options:
ready,
deleting
labels
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
last_used_at
string<date-time> | null
required

Last attach or save; null before the first.

head_checkpoint
integer | null
required

The checkpoint a new attachment restores by default; null while the volume is empty.

Required range: x >= 1
checkpoint_count
integer
required
Required range: x >= 0
stored_bytes
integer
required

Total stored bytes for this volume, or last observed whole-volume disk usage (zero before an observation). Prefer observed_volume_bytes, which distinguishes unknown from zero. Not a per-checkpoint size.

Required range: x >= 0
limits
object
required
attachments
object[]
required

All attachments, ordered by sandbox_id. Empty when unused.

observed_volume_bytes
integer | null

Last observed whole-volume disk usage, or null when unavailable. Not a checkpoint size or a billing amount.

Required range: x >= 0