Skip to main content
GET
Follow a command

Authorizations

Authorization
string
header
required

A team API key, sk_offstage_…, created in the console. Everything it touches belongs to its team.

Path Parameters

sandboxId
string
required

A sandbox id, sbx_….

commandId
string
required

The commandId from runCommand, cmd_….

Query Parameters

wait
number
default:0

Hold the request up to this many seconds for it to end. 0 to 60 is accepted; the plane never holds more than 50 s.

Required range: 0 <= x <= 60

Response

The command has ended.

A command that ended. The fields after state are the Mac's own answer, relayed as it sent them.

commandId
string
required

cmd_….

Pattern: ^cmd_
state
any
required
exitCode
integer | null
required

Null when the command was killed at its timeout.

timedOut
boolean
required
stdout
string
required

The last 1 MiB of standard output. In a gui sandbox it carries both streams.

stderr
string
required

The last 1 MiB of standard error. Empty in a gui sandbox.

truncated
boolean
required

True when the start of a stream was dropped to keep its last 1 MiB.

durationMs
integer
required
Required range: x >= 0