Skip to main content
POST
List app files

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose sandbox to operate on.

Body

application/json
path
string | null

Directory relative to the app root. Default: app root.

recursive
boolean
default:false

List nested entries.

max_depth
integer
default:3

Max depth when recursive.

Required range: 1 <= x <= 10
include_hidden
boolean
default:false

Include dotfiles.

Response

The listing.

The listing, and whether you got all of it.

entries
DirectoryEntry · object[]
required

Files and directories, capped at 1000 entries.

Example:
truncated
boolean
required

true when the listing hit the 1000-entry cap. Narrow it with path or a smaller max_depth.

Example:

false