---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a scale set"
description: "`runners.scale_sets.get` (GET /v1/{name}): Gets a scale set."
type: reference
product: runners
summary: "Gets a scale set."
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 scale set.

**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`
- **Scope** `runners:read`
- **Effect** `read` — nothing is written.
- **Collection** [scale_sets](/docs/api/scale_sets)

## Request

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

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/scale_sets/{scale_set}`. |
| `uid` | `string` | `rss_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ScaleSetSpec` | Desired state. Required. |
| `status` | `ScaleSetStatus` | Observed state. 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. |

### ScaleSetSpec

| Field | Type | What it is |
| --- | --- | --- |
| `connection` | `string` | The Sylphx Runners installation Connection. Required. |
| `runner_class` | `string` | The class, `sylphx-<os>-<size>`, for example `sylphx-linux-standard`. It is the label workflows ask for. Required. |
| `runner_group` | `string` | The forge runner group to register in; default the installation's default group. |
| `max_runners` | `int32` | Concurrent runners at most; 0 means the plan's limit. |

### ScaleSetStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `registration` | `string` | The forge's id of the registered scale set. Output only. |
| `session_region` | `string` | The region whose holder owns the message session. Output only. |
| `busy_runners` | `int32` | Runners running a job. Output only. |
| `idle_runners` | `int32` | Runners waiting for a job. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## 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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

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

**Rust**

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

**CLI**

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

**Terraform**

```hcl
data "sylphx_runners_scale_set" "scale_set" {
  name = "orgs/acme/scale_sets/scale-set"
}
```

**MCP**

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