Skip to main content
GET
List the command and process history

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}$

Query Parameters

mode
string

Only these modes, comma-separated: sync, stream, detached, process, or commands for the first three. Default: all.

Examples:

"process"

"commands"

"sync,detached"

q
string

Only commands whose command line contains this text, in any case.

Maximum string length: 200
Example:

"npm run"

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

The nextCursor of the previous page.

Response

One page of commands.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "command.list"
commands
object[]
required

Newest first.

nextCursor
string | null
required

Pass as cursor to get the next page. Null on the last page.