Skip to main content
Get unattended command state

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

operation_id
string
required

Workspace-owned launch operation returned by create.

Minimum string length: 1

Response

Current bounded observation of the unattended command.

The bounded state of a launch's unattended command. This handle excludes command text, environment variables, private process identity and all output. unknown is returned when the command outcome cannot be confirmed.

launch_id
string
required
Minimum string length: 1
sandbox_id
string
required
Minimum string length: 1
command_started_at
string<date-time>
required
timeout_seconds
integer
required

Fixed command runtime bound set when the command started.

Required range: x >= 1
state
enum<string>
required

Known observations. Clients must preserve unrecognized values for forward compatibility.

Available options:
running,
exited,
timed_out,
unknown
exit_code
integer | null
required

Confirmed exit status for exited or timed_out commands; null while running or when the outcome is unknown.