Projects REST API

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. A valid project key for the project may also be used for authentication.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a project.

Update a project. The user must have `edit` permissions for the project. Setting the `bmf_version` field requires a server admin.

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a project.

Body Parameters

Server admin only: Set the default BMF version for the project.

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. It must use http or https. 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

Delete a project. The user must have `manage` permissions for the project. By default, projects are soft-deleted. Set the `hard` query parameter to `true` to permanently delete the project (requires server admin).

Headers

Set to application/json.

Set to Bearer BENCHER_API_KEY, where BENCHER_API_KEY is a valid Bencher API key (or a deprecated API token).

Path Parameters

The slug or UUID for a project.

Query Parameters

Hard delete the project (requires server admin).