Skip to content

CLI reference — Runners

Generated by bun run generate:cli-reference from spec/admin-api-openapi.json. Do not hand-edit — regenerate after refreshing the spec.

Every operation below is documented CLI-first (nayaone-admin api <operationId>) per PRD-407/DO-7. The REST /admin-api/* method+path is the fallback/alternative integration option.

13 operations in this area.

Converge a runner’s owning infra-<vendor> partition (preview|up|refresh; destroy forbidden) (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminConvergeRunner --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/converge

Create a runner (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminCreateRunner --body '{}'

REST fallback: POST /admin-api/runners

Delete a runner (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminDeleteRunner --param id=<id> --body '{}'

REST fallback: DELETE /admin-api/runners/{id}

Runner fleet cost (Admin only) — current or entirety mode

CLI (preferred):

Terminal window
nayaone-admin api adminListFleetCost

REST fallback: GET /admin-api/runners/cost

Get infrastructure resources for a runner (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminListRunnerResources --param id=<id>

REST fallback: GET /admin-api/runners/{id}/resources

Mutate runner spec (Admin only) — PRD-181

CLI (preferred):

Terminal window
nayaone-admin api adminPatchRunner --param id=<id> --body '{}'

REST fallback: PATCH /admin-api/runners/{id}

Reconcile runner CF tunnel (W-2/W-3) without infra VM rebuild (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminReconcileRunnerTunnel --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/reconcile-tunnel

Retry runner provisioning dispatch (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminRetryRunnerProvision --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/retry-provision

Sync runner status (Admin only)

CLI (preferred):

Terminal window
nayaone-admin api adminSyncRunner --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/sync

RunnerDetail page bundle (PRD-132)

CLI (preferred):

Terminal window
nayaone-admin api getRunnerBundle --param runnerId=<runnerId>

REST fallback: GET /admin-api/runners/{runnerId}/bundle

PRD-92 S-1 — the runner’s Headscale mesh peers (control-plane view)

CLI (preferred):

Terminal window
nayaone-admin api getRunnerMeshPeers --param runnerId=<runnerId>

REST fallback: GET /admin-api/runners/{runnerId}/mesh-peers

Mint a single-use Headscale preauth key for a runner (internal — cloud-init)

CLI (preferred):

Terminal window
nayaone-admin api mintRunnerTailscaleBootstrapEnv --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/tailscale-bootstrap-env

Runner status callback (internal — startup script / infra.yml)

CLI (preferred):

Terminal window
nayaone-admin api submitRunnerStatus --param id=<id> --body '{}'

REST fallback: POST /admin-api/runners/{id}/status