BEbencherdev
runners

List runners

Changed on

➕ Bencher Plus: List all runners on the server. The user must be an admin to use this endpoint.

get/v0/runners

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

'name'

Sort by runner name.

OR
'created'

Sort by creation date.

The field to sort by. If not specified, the default sort field is used.

archivedboolean

Include archived runners.

namestring

Filter by runner name, exact match.

searchstring

Search by runner name, slug, or UUID.

Response

successful operation

archivedstring date-time
createdstring date-time required
last_heartbeatstring date-time
modifiedstring date-time required
namestring required
slugstring required
specsSpecUuid[] required
uuidstring uuid required

Changes