GET /v1/sandboxes/{id}/fs/list

Sandboxes

get/v1/sandboxes/{id}/fs/list

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/v1/sandboxes/{id}/fs/list
Auth: HTTP bearer

idstring required

pathstring required

Absolute path of a directory inside the sandbox

pageinteger

1-based page (default 1)

page_sizeinteger

Entries per page (default 20, max 100)

One page of directory entries (exists=false when missing, is_dir=false for a file — not errors)

existsboolean required

false when the path does not exist (not an error).

has_moreboolean required

More entries exist after this page.

is_dirboolean required

false when the path exists but is not a directory.

pageinteger required

1-based page these entries are.

page_sizeinteger required

Entries per page that was applied (default 20, at most 100).

pathstring required

totalinteger required

Entries in the whole directory, so ceil(total / page_size) is the number of pages. At most 10000: see truncated.

truncatedboolean required

The directory has more entries than the listing reads (10000), so total and the pages cover only the first 10000 names the filesystem returned.