Skip to main content
GET
Get detached command status and logs

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

tailBytes
integer

Cap each returned log to its last N bytes. Defaults to 8388608 (8 MiB). Ignored with offsets.

Required range: 1 <= x <= 8388608
stdoutOffset
integer

Return only stdout written from this byte offset. Use stdoutNextOffset of the previous answer.

Required range: x >= 0
stderrOffset
integer

Return only stderr written from this byte offset. Use stderrNextOffset of the previous answer.

Required range: x >= 0

Response

Process status and log tails, or the output since the offsets.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "command.status"
success
boolean
required
processId
integer
required
status
enum<string>
required

lost: the sandbox agent restarted and forgot the process; running/exitCode are then a best-effort probe and the logs come from the on-disk files.

Available options:
running,
exited,
lost
running
boolean
required
exitCode
integer | null
required
stdout
string
required

Tail of the stdout log file. With stdoutOffset: the stdout written since that offset.

stderr
string
required

Tail of the stderr log file. With stderrOffset: the stderr written since that offset.

pid
integer
known
boolean

Whether the process is still tracked by the sandbox agent.

signal
string | null
oomKilled
boolean

True when the memory ceiling killed the command or one of its processes and the command failed.

command
string | null
cwd
string | null
startedAt
string<date-time> | null
finishedAt
string<date-time> | null
stdoutTruncated
boolean
stderrTruncated
boolean
logPath
string
errLogPath
string
stdoutOffset
integer

Byte offset where stdout starts: the offset you asked for, or 0 when the log was replaced.

stderrOffset
integer

Byte offset where stderr starts: the offset you asked for, or 0 when the log was replaced.

stdoutNextOffset
integer

The stdoutOffset for the next read.

stderrNextOffset
integer

The stderrOffset for the next read.

more
boolean

True when more output is already written. Read again at once.