---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Scale sets"
description: "The `scale_sets` collection of Sylphx Runners: A ScaleSet registers one runner class on one Sylphx Runners installation."
type: reference
product: runners
summary: "A ScaleSet registers one runner class on one Sylphx Runners installation."
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 ScaleSet registers one runner class on one Sylphx Runners installation. Runners holds its message session with one fenced holder, and GitHub matches jobs to its runners; Runners keeps no global queue.

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

**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}`. |
| `uid` | `string` | `rss_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `ScaleSetSpec` | Desired state. Required. |
| `status` | `ScaleSetStatus` | Observed state. 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/scale_sets#get) | Gets a scale set. |
| `GET` | [`list`](/docs/api/scale_sets#list) | Lists scale sets in a org. |
| `POST` | [`create`](/docs/api/scale_sets#create) | Creates a scale set. The Operation is done when the controller settles it. |
| `PATCH` | [`update`](/docs/api/scale_sets#update) | Updates a scale set. |
| `DELETE` | [`delete`](/docs/api/scale_sets#delete) | Deletes a scale set. |

## get

Gets a scale set.

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

## list

Lists scale sets in a org.

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

## create

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

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

## update

Updates a scale set.

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

## delete

Deletes a scale set.

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