Namespaces
Methods
(route) create(:id)
Route:
| Method | Path |
|---|---|
| POST | /api/bucket/:id/alerts |
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
| name | String | Alert name | |
| enabled | Boolean | optional | Alert's state |
| type | String | Should be `metric`, `event` or `webcheck` | |
| initiator | String | Should be metric name or event name | |
| options | Object | ||
| options.operator | String | optional | Should be `>`, `<`, `=`, `>=` or `<=` |
| options.threshold | Number | optional | Value to reach to send an alert |
| options.act | String | optional | Should be `always`, `opposite`, `first` or `diff` |
| options.timerange | Number | optional | Timerange to check, in seconds |
| scope | Object | ||
| scope.apps | Object | optional | Array of strings with apps name (can be empty) |
| scope.servers | Object | optional | Array of strings with servers name (can be empty) |
| scope.initiators | Object | optional | Array of strings with initiators name (need to be set if no apps or servers) |
| scope.sources | Object | optional | Array of strings with sources name (can be empty) |
| actions | Object | List of actions to trigger | |
| actions[].type | String | optional | Type of action |
| actions[].params | Object | optional | Params for action |
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 |
| 400 | missing parameters |
| 200 | successfuly created alert |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id |
(route) delete(:id, :alert)
Route:
| Method | Path |
|---|---|
| DELETE | /api/bucket/:id/alerts/:alert |
Route Parameters:
| Name | Type | Description |
|---|---|---|
| :id | String | bucket id |
| :alert | String | alert id |
Response Code:
| Type | Description |
|---|---|
| 500 | database error |
| 204 | successfuly deleted alert |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id | |
:alert |
alert id |
deleteEvent()
- Deprecated:
- Not used anymore
(async, route) get(:id, :alert)
Route:
| Method | Path |
|---|---|
| GET | /api/bucket/:id/alerts/:alert |
Authentication
A authentication is needed to access this endpoint
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 |
| 404 | alert not found |
| 200 | successfuly returned alert |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id | |
:alert |
alert id |
(route) list(:id)
Route:
| Method | Path |
|---|---|
| GET | /api/bucket/:id/alerts/ |
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 |
sendReport()
- Deprecated:
- Not used anymore
(route) triggerSample(:id, :alert)
Route:
| Method | Path |
|---|---|
| POST | /api/bucket/:id/alerts/:alert/sample |
Authentication
A authentication is needed to access this endpoint
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 |
| 404 | alert not found |
| 202 | successfuly sended alert actions |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id | |
:alert |
alert id |
(route) update(:id)
Route:
| Method | Path |
|---|---|
| POST | /api/bucket/:id/alerts/update |
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name | Type | Description |
|---|---|---|
| triggers | Object |
Header Parameters:
| Name | Type | Description |
|---|---|---|
| Authorization | String | bearer access token issued for the user |
Route Parameters:
| Name | Type | Description |
|---|---|---|
| :id | String | bucket id |
Response:
| Name | Type | Description |
|---|---|---|
| triggers | Object | new triggers object |
Response Code:
| Type | Description |
|---|---|
| 500 | database error |
| 400 | missing triggers parameter |
| 200 | succesfully update triggers |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id |
(route) updateAlert(:id, :alert)
Route:
| Method | Path |
|---|---|
| PUT | /api/bucket/:id/alerts/:alert |
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
| name | String | optional | Alert name |
| enabled | Boolean | optional | Alert's state |
| type | String | optional | Should be `metric`, `event` or `webcheck` |
| initiator | String | optional | Should be metric name or event name |
| options | Object | optional | |
| options.operator | String | optional | Should be `>`, `<`, `=`, `<=` or `>=` |
| options.threshold | Number | optional | Value to reach to send an alert |
| options.act | String | optional | Should be `always`, `opposite`, `first` or `diff` |
| options.timerange | Number | optional | Timerange to check, in seconds |
| scope | Object | optional | |
| scope.apps | Array | optional | Array of strings with apps name (can be empty) |
| scope.servers | Array | optional | Array of strings with servers name (can be empty) |
| scope.initiators | Object | optional | Array of strings with initiators name (need to be set if no apps or servers) |
| scope.sources | Object | optional | Array of strings with sources name (can be empty) |
| actions | Array | optional | List of actions to trigger |
| actions[].type | String | optional | Type of action |
| actions[].params | Object | optional | Params for action |
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 |
| 400 | missing parameters |
| 404 | alert not found |
| 200 | successfuly created alert |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id | |
:alert |
alert id |
(route) updateSlack(:id)
Route:
| Method | Path |
|---|---|
| POST | /api/bucket/:id/alerts/updateSlack |
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
| slack | Object | ||
| slack.active | Boolean | optional | |
| slack.url | Boolean | optional | needed if active is set to true |
Header Parameters:
| Name | Type | Description |
|---|---|---|
| Authorization | String | bearer access token issued for the user |
Route Parameters:
| Name | Type | Description |
|---|---|---|
| :id | String | bucket id |
Response:
| Name | Type | Description |
|---|---|---|
| bucket | Object |
Response Code:
| Type | Description |
|---|---|
| 500 | database error |
| 400 | missing triggers parameter |
| 200 | succesfully update triggers |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id |
(route) updateWebhooks(:id)
Route:
| Method | Path |
|---|---|
| POST | /api/bucket/:id/alerts/updateWebhooks |
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
| webhooks | Object | ||
| webhooks.active | Boolean | optional | |
| webhooks.url | Boolean | optional | needed if active is set to true |
Header Parameters:
| Name | Type | Description |
|---|---|---|
| Authorization | String | bearer access token issued for the user |
Route Parameters:
| Name | Type | Description |
|---|---|---|
| :id | String | bucket id |
Response:
| Name | Type | Description |
|---|---|---|
| bucket | Object |
Response Code:
| Type | Description |
|---|---|
| 500 | database error |
| 400 | missing triggers parameter |
| 200 | succesfully update triggers |
Parameters:
| Name | Type | Description |
|---|---|---|
:id |
bucket id |