Skip to content
SupaCloud Docs
Select themeSelect language

get_api_management_v1_runners

GET
/api/management/v1/runners
curl --request GET \
  --url https://example.com/api/management/v1/runners

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Every runner of the instance with status and token metadata

Media typeapplication/json
Array<object>

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
[
  {
    "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:read, 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"
}