Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Runners quickstart
A runner registered with a one-time token, then its job list.
A runner is registered once with a one-time token and then runs the jobs it is sent. This registers one, reads it back, and reads its jobs.
Today this runs on the management API
Self-hosted runners are registered with POST /v1/runners on the management API, as shown here. The scale_sets and runners collections of the API reference are not served at api.sylphx.com.
#1. Register the runner
A runner has a name, an operating system (linux, macos or windows) and an
architecture:
sylphx api POST /v1/runners -d '{"name":"build-box-1","platform":"linux","arch":"x64"}'The answer carries the runnerId (run_…) and a registrationToken. The
token is shown once: store it where the runner process on your machine can read
it.
#2. Read the runners
sylphx api GET /v1/runnersEach runner shows its name, platform, arch, version, status and
lastSeenAt. A new runner is offline until the process on your machine
connects.
#3. Read its jobs
sylphx api GET /v1/runners/$RUNNER_ID/jobs#GitHub installations
The GitHub organizations the Sylphx App is installed on are listed with:
sylphx api GET /v1/ci-settings/installations