Skip to main content
Get observed terminal state

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

sandbox_id
string
required

Workspace-owned BoxRouter sandbox ID, not an upstream ID.

Minimum string length: 1
Pattern: ^[^\u0000]*$
terminal_id
string
required

BoxRouter terminal ID owned by the addressed sandbox and workspace.

Minimum string length: 1

Response

Terminal state; an unknown exit code remains null.

id
string
required
sandbox_id
string
required
state
string
required

Known states are running, exited and unknown.

exit_code
integer | null
required

Present only after a confirmed shell exit; 129 follows a hang-up. Null is not success.