Skip to main content
PATCH
Administer a fleet runner

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Runner id (UUIDv7).

Body

application/json

Exactly one of action or assigned_policy must be present; both or neither is a 400.

action
enum<string>

The operator transition to apply.

Available options:
cordon,
drain,
revoke
assigned_policy
object

The policy assigned to one runner. agentsfleet delivers it to the host on enrollment and on every heartbeat. The host never declares its own policy.

Response

The runner's admin state, plus the stored assignment on the policy-update path.

id
string<uuid>
required
admin_state
enum<string>
required
Available options:
active,
cordoned,
draining,
drained,
revoked
assigned_policy
object

The policy assigned to one runner. agentsfleet delivers it to the host on enrollment and on every heartbeat. The host never declares its own policy.