Skip to main content
POST
Get a download URL for a sandbox file

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}$

Body

application/json
path
string
required

Absolute path, or path relative to the sandbox work directory (/home/user). It must resolve under /home/user or /tmp.

ttlSeconds
integer
default:900

How long the URL stays valid.

Required range: 1 <= x <= 3600

Response

Signed download URL.

ok
boolean
required
Example:

true

type
enum<string>
required

Stable success envelope discriminator added by v1.

Available options:
file.download_url,
file.upload_url
url
string<uri>
required

The signed URL. Send the request straight to it; it needs no Authorization header.

method
enum<string>
required

GET downloads the file. PUT uploads the request body as the file.

Available options:
GET,
PUT
path
string
required

The canonical path the URL is bound to.

expiresAt
string<date-time>
required