Skip to main content
DELETE
Stop a detached command

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

Response

The command is stopped.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "command.stopped"
processId
integer
required
running
boolean
required

Always false after a stop.

signaled
boolean
required

False when the process had already ended.

command
object | null
required

The history record of the command, with its final state.