Skip to main content
GET
Step candidates

Authorizations

Authorization
string
header
required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

step_id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Query Parameters

limit
integer
default:50

Max items to return (1-500)

Required range: 1 <= x <= 500
offset
integer | null
default:0

Items to skip

Required range: x >= 0
verdict
string

Comma-separated verdicts, e.g. eligible,excluded

Substring match on the machine name

Maximum string length: 200
req_id
string

One requirement's per-machine table: rows carry met and have

met
boolean

With req_id: only the machines that meet it (true) or miss it (false)

pool_id
string

Comma-separated pool ids: only machines in these pools are judged and counted

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

Counts, reason groups and a page of machines

counts
object
required
groups
object[]
required

Machines that cannot take the step, grouped by why

reqs
object[]
required

Per requirement: machines in scope that meet it, out of all in scope

licenses
object[]
required

Counted render licences the step consumes

data
object[]
required
total
integer
required
limit
integer
required
offset
integer
required
wait
object | null