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
| Field | Type | Description |
|---|---|---|
id | string | Starts with rnr_. |
type | string | The object type, always runner. |
environment_id | string | The environment. |
name | string | Name shown in the Console and in reports. |
labels | array | Free-form tags. Sessions can require labels through runner_selector on the environment. |
max_concurrent_sessions | integer | How many sessions the runner accepts at once, 1 to 64. |
status | string | online (heartbeat within 60 s), offline or draining. |
version | string | The runner software version it reported. |
active_sessions | integer | See the endpoint pages below. |
last_seen_at | string or null | Time of the last claim or heartbeat. |
created_at | string | When it was created, RFC 3339 UTC (some older objects use Unix seconds). |
token | string | The runner’s credential. Returned only by this call. Store it on the runner host only. |
Returned by
POST /v1/environments/{environment_id}/runnersDELETE /v1/environments/{environment_id}/runners/{runner_id}GET /v1/environments/{environment_id}/runnersGET /v1/environments/{environment_id}/runners/{runner_id}
Was this page helpful?