Sandbox work and access
Attach to a detached command
Stream the output of a command started with detached: true as it writes it, until it ends. Reconnect with the offsets every 10 minutes to follow it with no time limit.
GET
Attach to a detached command
Authorizations
Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.
Path Parameters
Public Sandbox id returned by create/list/get sandbox calls.
Pattern:
^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$Process id returned by a detached command start.
Required range:
x >= 1Query Parameters
Start stdout at this byte offset. 0 sends the whole log.
Required range:
x >= 0Start stderr at this byte offset. 0 sends the whole log.
Required range:
x >= 0Response
The output stream.
One line of GET /sandboxes/{sandboxId}/commands/{processId}/stream (application/x-ndjson).
attached: first line.processId,stdoutOffset,stderrOffset(where the output starts).stdout/stderr: a chunk.data, andnextOffsetfor that stream.heartbeat: sent after 15 s with no other line.exit: last line when the command ended and all its output was sent.status,exitCode,signal,stdoutOffset,stderrOffset.reconnect: last line after 10 minutes. Open the stream again with itsstdoutOffsetandstderrOffset. Nothing is lost or repeated.error: last line on a failure.error,message,stdoutOffset,stderrOffset.
Available options:
attached, stdout, stderr, heartbeat, exit, reconnect, error Available options:
running, exited, lost