Skip to main content
POST
Join machine

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
joinToken
string
machineFingerprint
string
hostname
string
os
string
arch
string
cpuCount
integer<int64>
memoryMb
string<uint64>
gpu
string[]
gpuCount
integer<int64>
preflight
object[]
schedulable
boolean
executor
string
cpuMillicores
string<int64>
gpuIds
string[]
networkSlotPoolSize
integer<int64>
containerStartConcurrency
integer<int64>
workerImage
string

Optional per-machine worker image override. The controlplane remembers the generated value as a baseline so untouched installs continue to follow future image tag changes while manually edited values remain pinned.

capabilities
string[]

Response

A successful response.

ok
boolean
errMsg
string
workspaceId
string
poolName
string
machineId
string
machineToken
string
bootstrap
object