Skip to main content
GET
Get file or directory details in 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

Response

File details.

ok
boolean
required
Example:

true

type
enum<string>
required

Stable success envelope discriminator added by v1.

Available options:
file.info,
folder.created,
file.permissions_set
name
string
required
path
string
required

Absolute path on the sandbox.

isDir
boolean
required
size
integer
required
mode
string
required

Octal permission bits, for example "0644".

modifiedAt
string<date-time>
required
success
boolean