Mint a connect token for a sandbox file transfer

Mint a short-lived, capability-scoped connect token that authorizes a
single file upload or download against the sandbox, and return the
sandbox-proxy endpoint to invoke with it. The caller streams the file
bytes directly to (or from) that endpoint with the token as a bearer
credential. application/octet-stream carries a single file and
application/x-tar a directory archive, with compression carried
separately by Content-Encoding: gzip in either direction; directory
downloads return application/x-tar with Content-Encoding: gzip. The
token is bound to this sandbox, operation, and path, and expires
shortly after issuance.

409 with code: sandbox_group_suspended if the sandbox group is suspended.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^sbx-[0-9a-v]{25}$

The ID of the sandbox

string
enum
required

The file operation to authorize — upload (PUT a file or tar archive) or download (GET a file, or a directory as a tar archive).

Allowed:
Query Params
string

The ID of the workspace the sandbox belongs to. Optional: the workspace is
determined from the sandbox ID, and this parameter is ignored when supplied.

string
required

Path in the sandbox this token authorizes. A relative path resolves within the sandbox's home directory ("." is the home directory itself); an absolute path addresses the sandbox filesystem root. For an archive upload, the extraction root; for a download, the file or directory to fetch.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json