Skip to main content
GET
Attach to a detached command

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}$
processId
integer
required

Process id returned by a detached command start.

Required range: x >= 1

Query Parameters

stdoutOffset
integer
default:0

Start stdout at this byte offset. 0 sends the whole log.

Required range: x >= 0
stderrOffset
integer
default:0

Start stderr at this byte offset. 0 sends the whole log.

Required range: x >= 0

Response

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, and nextOffset for 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 its stdoutOffset and stderrOffset. Nothing is lost or repeated.
  • error: last line on a failure. error, message, stdoutOffset, stderrOffset.
type
enum<string>
required
Available options:
attached,
stdout,
stderr,
heartbeat,
exit,
reconnect,
error
processId
integer
data
string
nextOffset
integer
stdoutOffset
integer
stderrOffset
integer
status
enum<string>
Available options:
running,
exited,
lost
exitCode
integer | null
signal
string | null
error
string
message
string