Methods
(route) editState(:id, :alert)
Route:
| Method | Path |
|---|
| PUT |
/api/bucket/:id/alerts/analyzer/:alert |
Edit state analyzer alert (useful or not)
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| useful |
Boolean |
|
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :alert |
String |
alert id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
content modified |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:alert |
|
alert id |
(async, route) list(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/alerts/analyzer |
List analyzer alerts
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| size |
Integer |
optional |
line limit, default to 20 |
| from |
Integer |
optional |
offset limit |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
list all alerts |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) updateConfig(:id, :analyzer)
Route:
| Method | Path |
|---|
| PUT |
/api/bucket/:id/alerts/analyzer/:analyzer/config |
Edit analyzer configuration
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| blacklist |
Object |
|
|
| blacklist.apps |
Array |
optional |
|
| blacklist.servers |
Array |
optional |
|
| blacklist.metrics |
Array |
optional |
|
| threshold |
Number |
|
|
| window |
Number |
|
|
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :analyzer |
String |
analyzer name |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
content modified |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:analyzer |
|
analyzer name |