---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Runners"
description: "The `runners` collection of Sylphx Runners: A Runner is one runner: one machine for exactly one job, on its own Sandboxes lease, released and wiped after."
type: reference
product: runners
summary: "A Runner is one runner: one machine for exactly one job, on its own Sandboxes lease, released and wiped after."
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A Runner is one runner: one machine for exactly one job, on its own Sandboxes lease, released and wiped after. Runners is its only writer; callers read it.

**Service** Sylphx Runners · **Resource type** `runners.sylphx.com/Runner` · **Name pattern** `orgs/{org}/scale_sets/{scale_set}/runners/{runner}` · **Shape** `record`

**Not available yet.** Sylphx Runners is declared in the registry but no backend serves it: every call answers `501` with the problem code `UNIMPLEMENTED`.

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/scale_sets/{scale_set}/runners/{runner}`. |
| `uid` | `string` | `rnr_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `state` | `RunnerState` | The lifecycle state. Output only. One of `provisioning`, `idle`, `busy`, `finished`, `failed`. |
| `failure` | `RunnerFailure` | Why it never ran a job, when `state` is FAILED. Output only. One of `no_capacity`, `class_not_offered`, `capability_missing`, `boot_failed`. |
| `runner_class` | `string` | The class it runs as. Output only. |
| `lease` | `string` | Its Sandboxes lease. Output only. |
| `repository` | `string` | The repository of its job, `<owner>/<name>`. Output only. |
| `job_uri` | `string` | The job on the forge. Output only. |
| `start_time` | `timestamp` | When its job started. Output only. |
| `end_time` | `timestamp` | When its job ended. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/runners#get) | Gets a runner. |
| `GET` | [`list`](/docs/api/runners#list) | Lists runners in a scale set. |

## get

Gets a runner.

`GET https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners/runner` · scope `runners:read` · effect `read` · not available yet · [Request, response and examples](/docs/api/runners/get)

## list

Lists runners in a scale set.

`GET https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners` · scope `runners:read` · effect `read` · not available yet · paginated · [Request, response and examples](/docs/api/runners/list)