Projects REST API

List all projects. If the user is not authenticated, then only public projects are returned. If the user is authenticated, then all public projects and any private project where the user has `view` permissions are returned. By default, the projects are sorted in alphabetical order by name. The HTTP response header `X-Total-Count` contains the total number of projects.

Headers

---

Set to application/json.

---

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

Query Parameters

---

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

Default: asc

One of: asc, desc

---

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

Default: 1

---

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

Default: 8

---

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

Default: name

One of: name

---

Filter by project name, exact match.

---

Search by project name, slug, or UUID.

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

View OpenAPI Spec

View a project. If the user is not authenticated, then only a public project is available. If the user is authenticated, then any public project and any private project where the user has `view` permissions is available.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

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

View OpenAPI Spec

Update a project. The user must have `edit` permissions for the project.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

Body Parameters

---

The new name of the project. Maximum length is 64 characters.

---

The preferred new slug for the project. Maximum length is 64 characters.

---

The new URL of the project. Set to `null` to remove the current URL.

---

➕ Bencher Plus: Set the new visibility of the project. Moving to a `private` project requires a valid Bencher Plus subscription.

One of: public, private

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

View OpenAPI Spec

Delete a project. The user must have `delete` permissions for the project.

Headers

---

Set to application/json.

---

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

Path Parameters

---

The slug or UUID for a project.

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

View OpenAPI Spec