API reference · Sandboxes
List a directory of the sandbox’s workspace
/v1/sandboxes/{sandbox_id}/files- TypeScript
client.sandboxes.listFiles()- Python
client.sandboxes.list_files()- CLI
hayonix sandboxes files list
Lists one directory (not recursive), sorted by name, at most 1000 entries. Works only while the sandbox is running (409 sandbox_not_ready while it starts, sandbox_ended after it ends); like every file operation it counts as activity for the idle timeout.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the sandbox:read permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/sandboxes/sbx_01jc5zq4m8k3v6x9t2w7r0b1e4/files" \
-H "Authorization: Bearer $API_KEY"Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Path parameters
sandbox_idstringrequiredID of the sandbox
ID with prefix sbx_
Query parameters
pathstringRelative to the workspace (/workspace); "" or "." is the workspace itself
up to 1024 characters
Response
200 SandboxFileList — The directory’s entries, by name
objectstringrequiredAlways `list`: the type of this object
One of
listpathstringrequiredThe directory listed, relative to the workspace
The items
ShowHide 6 fields of
dataobjectstringrequiredAlways `sandbox_file`: the type of this object
One of
sandbox_filenamestringrequiredIts name
pathstringrequiredRelative to the workspace
typestringrequired`file`, `directory`, `symlink` (a symbolic link) or `other` (for example a socket)
One of
filedirectorysymlinkothersizeintegerrequiredSize in bytes
modified_atstring (date-time)requiredTime modified (ISO 8601, UTC)
next_cursorany JSON | nullrequiredAlways null: a listing is one page, cut short when `truncated` is true
truncatedbooleanrequiredMore than 1000 entries: the rest are left out
Example response
{
"object": "list",
"path": "string",
"data": [
{
"object": "sandbox_file",
"name": "string",
"path": "string",
"type": "file",
"size": 1,
"modified_at": "2026-01-01T00:00:00.000Z"
}
],
"next_cursor": {},
"truncated": true
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |