Skip to main content
GET
Get detached command status and logs

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

Public Box id returned by create/list/get box 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 524288 (512 KiB).

Required range: 1 <= x <= 524288

Response

Process status and log tails.

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 Box 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.

stderr
string
required

Tail of the stderr log file.

pid
integer
known
boolean

Whether the process is still tracked by the Box agent.

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