---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx runners scale_sets"
description: "The sylphx runners scale_sets commands of Sylphx Runners: every verb, with its argument, its flags and a run line."
type: reference
product: runners
summary: "Every sylphx runners scale_sets command: its argument, its flags and a run line."
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.

The `scale_sets` commands of Sylphx Runners, as the CLI spells them: the same
calls as [the `scale_sets` API page](/docs/api/scale_sets), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

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

## get

Gets a scale set.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

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

## list

Lists scale sets in a org.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx runners scale-sets list orgs/acme
```

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

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates a scale set. The Operation is done when the controller settles it.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx runners scale-sets create --parent orgs/acme --spec.connection … --spec.runner-class …
```

`POST https://api.sylphx.com/v1/orgs/acme/scale_sets` · scope `runners:write` · effect `write` · [Request, response and examples](/docs/api/scale_sets/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.connection` | `string` | The Sylphx Runners installation Connection. Required. |
| `--spec.runner-class` | `string` | The class, `sylphx-<os>-<size>`, for example `sylphx-linux-standard`. It is the label workflows ask for. Required. |
| `--spec.runner-group` | `string` | The forge runner group to register in; default the installation's default group. |
| `--spec.max-runners` | `int` | Concurrent runners at most; 0 means the plan's limit. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## update

Updates a scale set.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`PATCH https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set` · scope `runners:write` · effect `write` · [Request, response and examples](/docs/api/scale_sets/update)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.runner-group` | `string` | The forge runner group to register in; default the installation's default group. |
| `--spec.max-runners` | `int` | Concurrent runners at most; 0 means the plan's limit. |
| `--allow-missing` | `bool` | Create the Resource when it does not exist (declarative upsert). |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |

## delete

Deletes a scale set.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

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

`DELETE https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set` · scope `runners:write` · effect `destructive` · [Request, response and examples](/docs/api/scale_sets/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the Resource does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--force` | `bool` | Also delete every child Resource; without it a parent with children fails with FAILED_PRECONDITION. |
| `--no-wait` | `bool` | Return the call at once instead of waiting for it to finish. |
| `--yes` | `bool` | Do not ask before this destructive call. |