Skip to main content
List volumes

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Query Parameters

cursor
string

Opaque cursor from the preceding page; scoped to the original workspace and query.

Required string length: 1 - 128
Pattern: ^[^\u0000]*$
limit
integer
default:20

Maximum number of records to return.

Required range: 1 <= x <= 100

Response

Volumes

data
object[]
required
next_cursor
string | null
required
stored_bytes
integer

Current sum of stored bytes for ready retained checkpoints plus last observed disk usage for visible volumes. Not a billing amount.

Required range: x >= 0
live_volume_policy
object

Present only when live storage is enabled and this workspace is allowlisted. Absence does not authorize live creation.

allowance_bytes
integer

The volume storage this workspace has included, in bytes. It is workspace configuration, so read it here instead of assuming a number. Storage within it is not charged.

Required range: x >= 0
gib_hours_this_month
number

GiB-hours of stored volume data over the completed UTC hours since the start of this month. Metered usage, not a billing amount.

Required range: x >= 0