Skip to main content
POST
Register a pending terminal for explicit browser approval

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required
Maximum string length: 128
workspace
string
required
Maximum string length: 2048
secretHash
string
required

SHA-256 digest of the random device secret, encoded as 64 hex characters.

agentTerminalId
string<uuid>
deviceId
string<uuid>
deprecated

Legacy runner alias.

Response

201 - application/json
agentTerminalId
string<uuid>
required
ownerUserId
string<uuid>
required
name
string
required
workspace
string
required
workspaces
object[]
required

Atomic workspace permission contract under the terminal revision.

status
enum<string>
required
Available options:
pending,
approved
mode
enum<string>
required
Available options:
review,
full
networkMode
enum<string>
required
Available options:
restricted,
sandbox,
external
revision
number
required
connectionRevision
number
required

Runner and conversation connection epoch; command review mode edits keep it unchanged.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
restricted
boolean
required
users
string[]
required
groups
string[]
required
refToken
string

Clickable terminal resource reference.

lastOnlineAt
string<date-time> | null
online
boolean
connectionIp
string | null

Gateway-observed IP of the active runner, visible only to its owner.

canManage
boolean
createdBy
string<uuid>
lastUpdateAt
string<date-time>
lastUpdateBy
string<uuid>
version
number