Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Runners

A Runner is one runner: one machine for exactly one job, on its own Sandboxes lease, released and wiped after.

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 Runner is one runner: one machine for exactly one job, on its own Sandboxes lease, released and wiped after. Runners is its only writer; callers read it.

Service Sylphx Runners · Resource type runners.sylphx.com/Runner · Name pattern orgs/{org}/scale_sets/{scale_set}/runners/{runner} · Shape record

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}/runners/{runner}.
uidstringrnr_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
stateRunnerStateThe lifecycle state. Output only. One of provisioning, idle, busy, finished, failed.
failureRunnerFailureWhy it never ran a job, when state is FAILED. Output only. One of no_capacity, class_not_offered, capability_missing, boot_failed.
runner_classstringThe class it runs as. Output only.
leasestringIts Sandboxes lease. Output only.
repositorystringThe repository of its job, <owner>/<name>. Output only.
job_uristringThe job on the forge. Output only.
start_timetimestampWhen its job started. Output only.
end_timetimestampWhen its job ended. 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 runner.
GETlistLists runners in a scale set.

#get

Gets a runner.

GET https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners/runner · scope runners:read · effect read · not available yet · Request, response and examples

#list

Lists runners in a scale set.

GET https://api.sylphx.com/v1/orgs/acme/scale_sets/scale-set/runners · scope runners:read · effect read · not available yet · paginated · Request, response and examples