The runner object

⚠️
Preview — this feature is being built; the design below is the spec.

The runner object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "rnr_01JCD0B2D4F6H8K0M2P4",
  "type": "runner",
  "environment_id": "env_01JC5B2D4F6H8K0M2P4R",
  "name": "dc1-build-01",
  "labels": [
    "gpu",
    "eu"
  ],
  "max_concurrent_sessions": 4,
  "status": "offline",
  "version": null,
  "active_sessions": 0,
  "last_seen_at": null,
  "created_at": "2026-11-01T08:00:00Z",
  "token": "srt_live_4Hc9…redacted"
}

Fields

FieldTypeDescription
idstringStarts with rnr_.
typestringThe object type, always runner.
environment_idstringThe environment.
namestringName shown in the Console and in reports.
labelsarrayFree-form tags. Sessions can require labels through runner_selector on the environment.
max_concurrent_sessionsintegerHow many sessions the runner accepts at once, 1 to 64.
statusstringonline (heartbeat within 60 s), offline or draining.
versionstringThe runner software version it reported.
active_sessionsintegerSee the endpoint pages below.
last_seen_atstring or nullTime of the last claim or heartbeat.
created_atstringWhen it was created, RFC 3339 UTC (some older objects use Unix seconds).
tokenstringThe runner’s credential. Returned only by this call. Store it on the runner host only.

Returned by

Was this page helpful?