Skip to main content
GET
Look up a path on a volume

Authorizations

Authorization
string
header
required

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

Path Parameters

volume_id
string
required

Id of the volume, as returned by create.

Pattern: ^vol_

Query Parameters

path
string
required

Path on the volume, relative to its root, with or without a leading slash: skills/review.md and /skills/review.md name the same file. A .. segment is rejected.

Required string length: 1 - 4096

Response

The entry at path.

name
string
required

Name of the entry, without its directory.

type
string
required

What the entry is: file, directory, symlink, or other. A symlink is reported as itself in a listing, and as what it points at when you ask for one path.

size
integer<int64>
required

Size in bytes.

Required range: x >= 0
modified_time
number
required

When the entry last changed, in seconds since the Unix epoch.

mode
integer
required

POSIX permission bits, as a decimal number.

Required range: 0 <= x <= 4095