Runners REST API

List runners

โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

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

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Query Parameters

direction

string

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

Default: asc

One of: asc, desc

page

integer

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

Default: 1

per_page

integer

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

Default: 8

sort

string

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

One of: name, created

archived

boolean

Include archived runners.

name

string

Filter by runner name, exact match.

search

string

Search by runner name, slug, or UUID.

GET
/v0/runners
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher runner list

View OpenAPI Spec

Create a runner

โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

โž• Bencher Plus: Create a new runner on the server. The user must be an admin to use this endpoint. Returns the runner token which is only shown once.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Body Parameters

name

string

Required

The name of the runner.

slug

The preferred slug for the runner. If not provided, the slug will be generated from the name.

POST
/v0/runners
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher runner create

View OpenAPI Spec

View a runner

โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

โž• Bencher Plus: View a runner on the server. The user must be an admin to use this endpoint.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Path Parameters

runner
Required

The slug or UUID for a runner.

GET
/v0/runners/{runner}
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher runner view RUNNER

View OpenAPI Spec

Update a runner

โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

โž• Bencher Plus: Update a runner on the server. The user must be an admin to use this endpoint. Can be used to archive or unarchive a runner.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Path Parameters

runner
Required

The slug or UUID for a runner.

Body Parameters

archived

boolean

Set whether the runner is archived.

name

string

The new name for the runner.

slug

The new slug for the runner.

PATCH
/v0/runners/{runner}
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher runner update RUNNER

View OpenAPI Spec

Rotate runner token

โš ๏ธ Breaking Changes: The Bencher API is in beta and under active development. We may introduce breaking changes in future releases. We will announce any breaking changes in the release notes.

โž• Bencher Plus: Generate a new token for a runner, invalidating the old one. The user must be an admin to use this endpoint. Returns the new token which is only shown once.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

Required

Set to Bearer BENCHER_API_TOKEN, where BENCHER_API_TOKEN is a vaild Bencher API token.

Path Parameters

runner
Required

The slug or UUID for a runner.

POST
/v0/runners/{runner}/token
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher runner token RUNNER

View OpenAPI Spec

Published: Mon, February 12, 2024 at 7:26:00 AM UTC | Last Updated: Sun, December 7, 2025 at 5:47:00 PM UTC