Skip to main content
GET
Get file or directory information

Authorizations

Authorization
string
header
required

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

Path Parameters

path
string
required

File or directory path. Relative paths are resolved against the filesystem working directory. For example, with a working directory of /app, GET /filesystem/workspace resolves to /app/workspace. To access the absolute path /workspace over HTTP, encode its leading slash as %2F: GET /filesystem/%2Fworkspace. The double-slash form GET /filesystem//workspace also addresses /workspace.

Query Parameters

download
boolean

Force download mode for files

Response

Directory listing

files
object[]
required
name
string
required
path
string
required
subdirectories
object[]
required

@name Subdirectories

recursive
boolean

Recursive is true when files and subdirectories hold every level below path (tree read with recursive=true). Older APIs ignore that parameter and omit this field, so clients can tell a one-level listing apart.