Skip to main content
PUT
Register or refresh the authenticated agent runner

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Organization identifier

Body

application/json

Strict agent-only runner registration body. Organization and agent member IDs are derived from authentication.

instanceId
string<uuid>
required
platform
enum<string>
required
Available options:
darwin,
linux,
windows
arch
enum<string>
required
Available options:
arm64,
x64,
amd64
capabilities
enum<string>[]
required
Maximum array length: 2
Available options:
codex,
git
clientVersion
string
required
Pattern: ^[0-9]{1,5}\.[0-9]{1,5}\.[0-9]{1,5}$
hostId
string
Required string length: 1 - 255

Response

Runner installation registered

runner
object | null
required