Project Alerts REST API

List alerts for a project

โš ๏ธ 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.

List all alerts for a project. If the project is public, then the user does not need to be authenticated. If the project is private, then the user must be authenticated and have `view` permissions for the project. By default, the alerts are sorted by status (active then dismissed) and modification date time in reverse chronological order. The HTTP response header `X-Total-Count` contains the total number of alerts.

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.

Path Parameters

project
Required

The slug or UUID for a project.

Query Parameters

direction

string

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

Default: desc

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: created, modified

archived

boolean

If set to `true`, only returns archived alerts. If not set or set to `false`, only returns alerts with non-archived branches, testbeds, or measures.

status

string

Filter alerts by their status. If not set, returns all alerts.

One of: active, dismissed, silenced

GET
/v0/projects/{project}/alerts
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher alert list PROJECT

View OpenAPI Spec

View an alert

โš ๏ธ 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 an alert for a project. If the project is public, then the user does not need to be authenticated. If the project is private, then the user must be authenticated and have `view` permissions for the project.

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.

Path Parameters

alert

string

Required

The UUID for an alert.

project
Required

The slug or UUID for a project.

GET
/v0/projects/{project}/alerts/{alert}
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher alert view PROJECT ALERT

View OpenAPI Spec

Update an alert

โš ๏ธ 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 an alert for a project. The user must have `edit` permissions for the project. Use this endpoint to dismiss an alert.

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

alert

string

Required

The UUID for an alert.

project
Required

The slug or UUID for a project.

Body Parameters

status

string,string

The new status of the alert.

One of: active, dismissed

PATCH
/v0/projects/{project}/alerts/{alert}
Bencher Cloud https://api.bencher.dev
Bencher Self-Hosted http://localhost:61016

Bencher CLI

bencher alert update PROJECT ALERT

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