Server Config REST API

View server configuration

⚠️ 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.

View the API server configuration. The user must be an admin on the server to use this route.

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.

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

Bencher CLI

bencher server config view

View OpenAPI Spec

Update server configuration

⚠️ 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.

Update the API server configuration. The user must be an admin on the server to use this route. Updating the configuration will cause the server to restart.

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

config

object

Required

See the Server Config reference for a full overview.

delay

integer

Default: 3

PUT
/v0/server/config
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher server config update

View OpenAPI Spec

View console configuration

⚠️ 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.

View the Bencher Console configuration managed by the API server. This is a public route and does not require authentication.

Headers

Content-Type

string

Required

Set to application/json.

Authorization

string

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

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

Bencher CLI

bencher server config console

View OpenAPI Spec

Published: Mon, February 12, 2024 at 7:26:00 AM UTC | Last Updated: Fri, June 21, 2024 at 5:47:00 PM UTC