Skip to content
SupaCloud Docs
Select themeSelect language

`PATCH /api/runners/config` — change the runtime fleet config (system-admin). `hub_mode_enabled` flips the process hub-mode (the boot env var stays the restart default); `least_loaded_dispatch` flips the persisted global RUNG-4 switch. Each provided lever is applied and audited; omitted levers are untouched.

PATCH
/api/runners/config
curl --request PATCH \
  --url https://example.com/api/runners/config \
  --header 'Content-Type: application/json' \
  --data '{ "hub_mode_enabled": true, "least_loaded_dispatch": true, "owner_onboarding_enabled": true, "workspace_fairness_enabled": true }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A fleet-config update. Both fields are optional so the UI can flip one lever without touching the other; a None field is left unchanged.

object
hub_mode_enabled
boolean | null
least_loaded_dispatch

ADR 0046 RUNG 4 — flip the persisted global least-loaded dispatch switch. This is the browser-session write path for the global switch (the operator-token route is unreachable from the session cookie).

boolean | null
owner_onboarding_enabled

ADR 0046 Phase 0 (decision #9) — flip the persisted global owner-onboarding switch (runner_onboarding_by_owner). System-admin lever: it grants OWNERS the ability to mint edge enrollment tokens for their own workspaces. Same global-switch transport as least_loaded_dispatch.

boolean | null
workspace_fairness_enabled

ADR 0046 RUNG 4c — flip the persisted global per-workspace fairness switch (workspace_fairness). When on, the runner CLAIM path applies per-workspace admission control so a single workspace cannot monopolise a shared runner pool (over-share work waits queue-pending). Same global-switch transport as least_loaded_dispatch.

boolean | null
Examplegenerated
{
  "hub_mode_enabled": true,
  "least_loaded_dispatch": true,
  "owner_onboarding_enabled": true,
  "workspace_fairness_enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated fleet config

Media typeapplication/json

Read-only fleet-config status, surfaced so the runners UI can show how the fleet dispatches. Both are instance-global levers.

object
hub_mode_enabled
required

Whether SUPACLOUD_HUB_MODE is enabled on the server. Runners only receive dispatched work when this is true.

boolean
least_loaded_dispatch
required

ADR 0046 RUNG 4 — whether weighted least-loaded dispatch ordering is on (the persisted global dispatch_least_loaded switch; default off = RUNG-0 registry order).

boolean
owner_onboarding_enabled
required

ADR 0046 Phase 0 (decision #9) — whether org/workspace owners may onboard edge runners scoped to workspaces they own (the persisted global runner_onboarding_by_owner switch; default off = system-admin-only onboarding).

boolean
workspace_fairness_enabled
required

ADR 0046 RUNG 4c — whether per-workspace fairness admission control is on (the persisted global workspace_fairness switch; default off = no admission control, byte-identical claim). When on, a single workspace cannot monopolise a shared runner pool — over-share work waits queue-pending at claim time (the runner skips claiming it) instead of being run.

boolean
Examplegenerated
{
  "hub_mode_enabled": true,
  "least_loaded_dispatch": true,
  "owner_onboarding_enabled": true,
  "workspace_fairness_enabled": true
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}