Skip to main content
GET
List a directory inside a sandbox

Authorizations

X-API-Key
string
header
required

Path Parameters

sandbox_id
string
required

The unique identifier of the sandbox. Public sandbox ID: a bare UUID, or the region-tagged form sb-<region>-<uuid> (e.g. sb-use-1b4e28ba-…). Treat as an opaque string; the tagged form routes the request to the sandbox's home region. Endpoints accept both forms interchangeably.

Pattern: ^(sb-[a-z0-9]+-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

path
string

Absolute directory path to list. Defaults to "/".

Example:

"/home/user"

Response

Directory listing

entries
object[]
required