Skip to main content
GET
/
v1
/
sandboxes
/
{id}
/
files
List directory contents
import requests

url = "https://api.13-215-85-171.sslip.io/v1/sandboxes/{id}/files"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
[
  {
    "name": "<string>",
    "path": "<string>",
    "is_dir": true,
    "size": 123,
    "type": "file",
    "mode": "0644",
    "permissions": "0644",
    "owner": "<string>",
    "group": "<string>",
    "modified_time": "2023-11-07T05:31:56Z",
    "symlink_target": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
id
string
required

Sandbox ID (e.g. sb_a1b2c3d4)

Query Parameters

​
path
string
default:/

Directory path to list inside the sandbox. Absolute paths may target valid sandbox locations such as /workspace, /data, /tmp, or /context where present. Relative paths resolve from the sandbox cwd when set, otherwise from the selected user's home when user is provided, otherwise from /workspace.

​
depth
integer

Optional recursion depth for nested directory listings.

Required range: x >= 1
​
user
string

Optional sandbox user for relative-path resolution and ownership.

Response

200 - application/json

Directory listing

​
name
string
required
​
path
string
required

Absolute resolved filesystem path. For sandbox routes this is an absolute sandbox path; for volume routes this is an absolute volume-internal path rooted at /.

​
is_dir
boolean
required
​
size
integer<uint64>
required
​
type
string
required

Entry type (e.g. "file", "directory", "symlink")

Example:

"file"

​
mode
string
Example:

"0644"

​
permissions
string
Example:

"0644"

​
owner
string
​
group
string
​
modified_time
string<date-time>
​
symlink_target
string