---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a runner"
description: "`runners.runners.get` (GET /v1/{name}): Gets a runner."
type: reference
product: runners
summary: "Gets a runner."
updated: 2026-09-28
nav: false
---

> **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.

Gets a runner.

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

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners/runner`
- **Scope** `runners:read`
- **Effect** `read` — nothing is written.
- **Collection** [runners](/docs/api/runners)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the runner to get. Required. |

## Response

| 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. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners/runner" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.runners.runners.get({ name: 'orgs/acme/scale_sets/scale-set/runners/runner' })
```

**Rust**

```rust
let mut req = sylphx::runners::GetRunnerRequest::default();
req.name = "orgs/acme/scale_sets/scale-set/runners/runner".to_string();
let response = sx.runners().runners().get(req).await?;
```

**CLI**

```bash
sylphx runners runners get orgs/acme/scale_sets/scale-set/runners/runner
```

**MCP**

```json
{ "method_id": "runners.runners.get", "args": {"name":"orgs/acme/scale_sets/scale-set/runners/runner"} }
```