Skip to main content
POST
Register a runner

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Body

application/json

POST /v1/runners request. Authorized by an existing operator credential, not an enrollment token. The operator ASSIGNS the policy; the host never declares one.

assigned_policy
object
required

The policy the operator assigns to it.

host_id
string
required

Stable identifier for the host being enrolled.

labels
string[]
required

Operator labels for placement and filtering.

Response

Runner registered; the bearer token is returned exactly once

POST /v1/runners reply: the durable identity plus its bearer token.

The token is returned ONCE — the daemon stores only its hash.

assigned_policy
object
required

The assignment AS STORED, with the worker count clamped, so the enrolling operator sees exactly what the host will apply.

runner_id
string
required

The runner's durable identifier.

runner_token
string
required

The minted bearer token. Secret — revealed once, never re-readable.