Skip to main content
GET
Read a file from a sandbox

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Query Parameters

path
string
required

Absolute path, or path relative to the sandbox work directory (/home/user). The canonicalized path must resolve under /home/user or /tmp; anything else is rejected with a 400 invalid_path error.

encoding
enum<string>
default:utf8
Available options:
utf8,
base64

Response

File contents.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "file.read"
success
boolean
required
path
string
required
encoding
enum<string>
required
Available options:
utf8,
base64
size
integer
required
content
string
required