Skip to content
SupaCloud Docs
Select themeSelect language

put_api_management_v1_runners_name_

PUT
/api/management/v1/runners/{name}
curl --request PUT \
  --url https://example.com/api/management/v1/runners/example \
  --header 'Content-Type: application/json' \
  --data '{ "allowed_labels": [ "example" ], "allowed_workspace_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "capabilities": {}, "class": "example", "drain_state": "example", "isolation": "example", "labels": [ "example" ], "tier": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
name
required
string

Management API runner name

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The desired state of a managed runner (PUT /management/v1/runners/{name}).

object
allowed_labels

Optional label ceiling of the grant; empty = no label restriction.

Array<string>
allowed_workspace_ids

Workspaces an edge runner may serve. null/absent = every workspace, which only a trusted runner may hold.

Array<string> | null
capabilities

Further capabilities, e.g. {"builds": true} or {"connectors": true}. The labels key is set from labels.

object
class
required

trusted (may serve every workspace) or edge (only allowed_workspace_ids).

string
drain_state

active, cordoned or draining; absent leaves it unchanged.

string | null
isolation

container (default) or microvm.

string | null
labels

Labels the runner advertises for worker-group routing (capabilities.labels).

Array<string>
tier

docker (default), wasm or both.

string | null
Examplegenerated
{
  "allowed_labels": [
    "example"
  ],
  "allowed_workspace_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "capabilities": {},
  "class": "example",
  "drain_state": "example",
  "isolation": "example",
  "labels": [
    "example"
  ],
  "tier": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Created or updated; never carries a token

Media typeapplication/json

The result of an upsert: the runner, and whether this call created it.

object
created
required
boolean
runner
required

A runner as an automation sees it.

object
allowed_labels
required
Array<string>
allowed_workspace_ids
required
Array<string> | null
capabilities
required
object
class
required
string
connected
required

online and heard from within the liveness window.

boolean
display_name
required

The display name.

string
drain_state
required

active, cordoned or draining.

string
id
required
string format: uuid
labels
required
Array<string>
last_seen_at
required
string | null format: date-time
name
required

The Management API name (managed_key); null for a runner registered in the browser or by enrollment.

string | null
status
required

pending, online, offline or disabled.

string
tokens
required
Array<object>

Token metadata — never the value.

object
active
required

Revoked tokens and tokens past their expiry are not active.

boolean
created_at
required
string format: date-time
expires_at
required
string | null format: date-time
id
required
string format: uuid
revoked_at
required
string | null format: date-time
Examplegenerated
{
  "created": true,
  "runner": {
    "allowed_labels": [
      "example"
    ],
    "allowed_workspace_ids": [
      "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    ],
    "capabilities": {},
    "class": "example",
    "connected": true,
    "display_name": "example",
    "drain_state": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "labels": [
      "example"
    ],
    "last_seen_at": "2026-04-15T12:00:00Z",
    "name": "example",
    "status": "example",
    "tokens": [
      {
        "active": true,
        "created_at": "2026-04-15T12:00:00Z",
        "expires_at": "2026-04-15T12:00:00Z",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "revoked_at": "2026-04-15T12:00:00Z"
      }
    ]
  }
}

403

Section titled “403”

Missing runners:write, or not an instance-level token

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 license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests 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"
}

409

Section titled “409”

The runner exists with a different class

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 license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests 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"
}

422

Section titled “422”

Invalid name, labels, capabilities or grant

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 license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests 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"
}