Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Scale sets

A ScaleSet registers one runner class on one Sylphx Runners installation.

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

FieldTypeWhat it is
namestringorgs/{org}/scale_sets/{scale_set}.
uidstringrss_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specScaleSetSpecDesired state. Required.
statusScaleSetStatusObserved 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.

MethodCallWhat it does
GETgetGets a scale set.
GETlistLists scale sets in a org.
POSTcreateCreates a scale set. The Operation is done when the controller settles it.
PATCHupdateUpdates a scale set.
DELETEdeleteDeletes 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

#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

#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

#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

#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