Skip to main content
GET
Volume Detail

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

owner
string
required
name
string
required

Query Parameters

path
string
default:""

Browse one directory level instead of listing every file

cursor
string
default:""

Continue a browse from a previous response's next_cursor

browse
boolean
default:false

Browse one level at a time, starting at the root

Response

Successful Response

The flat listing: every file up to the server's cap.

Told apart from VolumeLevelOut by its field set -- it has truncated and total_bytes, never folders or next_cursor.

id
string
required
owner
string
required
name
string
required
visibility
enum<string>
required
Available options:
private,
public,
team
description
string
required
created_at
integer
required
allow_download
boolean
required
allow_use
boolean
required
usable_by
string[]
required
allow_preview
boolean
required
watermark
boolean
required
watermark_text
string
required
classification
string
required
backing
string
required
connection
string
required
source_path
string
required
external
boolean
required
total_bytes
integer
required
measured
VolumeMeasuredOut · object | null
required

The last background measurement of the whole volume.

truncated
boolean
required
files
VolumeFileOut · object[]
required