Skip to main content
GET
List files or directories in a volume path

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Volume ID

Query Parameters

path
string

Absolute volume-internal path rooted at /. Defaults to / when omitted.

depth
integer<uint32>

Optional directory listing depth. Phase 3 currently supports only 1.

Response

Directory listing

name
string
required
path
string
required

Absolute resolved filesystem path. For machine routes this is an absolute machine path; for volume routes this is an absolute volume-internal path rooted at /.

is_dir
boolean
required
size
integer<uint64>
required
type
string
required

Entry type (e.g. "file", "directory", "symlink")

Example:

"file"

mode
string
Example:

"0644"

permissions
string
Example:

"0644"

owner
string
group
string
modified_time
string<date-time>