Skip to content

Tree

POST
/v1/sandbox/{sandboxID}/filesystem/tree

Get a hierarchical directory tree.

sandboxID
required
string

Unique sandbox identifier.

object
path
required

Root directory path for the tree.

string
exclude

Glob patterns to exclude (e.g. node_modules, .git).

Array<string>
max_depth

Maximum depth to traverse.

integer

Directory tree.

object
items
required

Hierarchical directory tree entries.

Array<object>
object
name
required

File or directory name.

string
type
required

Whether this entry is a file or directory.

string
Allowed values: file directory
children
Array<object> recursive

Bad request – validation error.

object
message
required

Summary message, e.g. “Invalid request”.

string
errors
required
Array<object>
object
field
required

JSON field name that failed validation (e.g. “path”, “command”).

string
error
required

Human-readable description of the validation failure.

string

Unauthorized – invalid or missing API key.

object
message
required

Human-readable error message.

string

Resource not found.

object
message
required

Human-readable error message.

string