Skip to main content
POST
Create a runner

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Body

application/json
name
string
required
Required string length: 1 - 80
Example:

"lenovo-lab-1"

Response

OK

A process next to a hypervisor that makes, runs and saves test machines. It connects out to GuidingHand.

object
any
runner_id
string
Example:

"rn_T2Lc0aQ3Vb7s"

name
string
Example:

"lenovo-lab-1"

scope
enum<string>

org: your own, serving only your org. cloud: GuidingHand’s, serving every org. Attempts go to your own runners first.

Available options:
org,
cloud
status
enum<string>
Available options:
online,
offline
provider
string | null
Example:

"qemu"

labels
string[]
Example:
slots
integer

Machines it runs at once.

busy
integer
images
string[]
Example:
version
string | null
last_seen_at
string<date-time> | null
created_at
string<date-time> | null
token
string

The runner’s token (gh_rn_…). Shown once.