Methods
(route) create(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/webchecks |
Create a webcheck
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| name |
String |
|
Webcheck name |
| enabled |
Boolean |
optional |
Webcheck's state |
| target |
Object |
|
|
| target.type |
String |
optional |
Should be `http`, `https` or `tcp` |
| target.port |
Number |
optional |
Target's port |
| target.address |
String |
optional |
Target's IP/domain |
| target.path |
String |
optional |
HTTP Path (only for http/https) |
| target.is_frontend |
Boolean |
optional |
Enable or disable frontend metrics (via puppeteer) |
| body |
String |
optional |
Body need to match this regex to succeed webcheck (only for http/https) |
| interval |
Number |
|
Webcheck's interval check (ms) |
| timeout |
Number |
|
Webcheck's timeout (ms) |
| source |
Object |
|
|
| source.region |
String |
optional |
Webcheck's worker region |
| retry |
Object |
|
|
| retry.max |
Number |
optional |
Max webcheck's retry before mark as failed |
| retry.interval |
Number |
optional |
Webcheck's retry interval (ms) |
| alerts |
Object |
|
List of alerts (cf. Alert type) |
| application |
String |
optional |
Application's id |
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 webcheck |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) delete(:id, :webcheck)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/webchecks/:webcheck |
Delete a webcheck
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :webcheck |
String |
webcheck id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 204 |
successfuly deleted webcheck |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:webcheck |
|
webcheck id |
(route) get(:id, :webcheck)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/webchecks/:webcheck |
Get a webcheck
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 |
| :webcheck |
String |
webcheck id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 404 |
webcheck not found |
| 200 |
successfuly retrieved webcheck |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:webcheck |
|
webcheck id |
(async, route) getMetrics(:id, :webcheck)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/webchecks/:webcheck/metrics |
List webchecks metrics
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| start |
String |
optional |
|
| metrics |
Array |
optional |
|
| end |
String |
optional |
|
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :webcheck |
String |
webcheck id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
successfuly retrieved webchecks regions |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:webcheck |
|
webcheck id |
(route) list(:id)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/webchecks |
List webchecks
Authentication
A authentication is needed to access this endpoint
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Query Parameters:
| Name |
Type |
Attributes |
Description |
| application |
String |
optional |
Application's id to filter |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
successfuly retrieved webchecks |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) listMetrics(:id)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/webchecks/metrics |
List metrics that can be output by a webcheck
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 |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
successfuly retrieved webchecks metrics |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) listRegions(:id)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/webchecks/regions |
List webchecks regions
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 |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
successfuly retrieved webchecks regions |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) update(:id, :webcheck)
Route:
| Method | Path |
|---|
| PUT |
/api/bucket/:id/webchecks/:webcheck |
Update a webcheck
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| name |
String |
optional |
Webcheck name |
| enabled |
Boolean |
optional |
Webcheck's state |
| target |
Object |
optional |
|
| target.type |
String |
optional |
Should be `http`, `https` or `tcp` |
| target.port |
Number |
optional |
Target's port |
| target.address |
String |
optional |
Target's IP/domain |
| target.path |
String |
optional |
HTTP Path (only for http/https) |
| target.is_frontend |
Boolean |
optional |
Enable or disable frontend metrics (via puppeteer) |
| body |
String |
optional |
Body need to match this regex to succeed webcheck (only for http/https) |
| interval |
Number |
optional |
Webcheck's interval check (ms) |
| timeout |
Number |
optional |
Webcheck's timeout (ms) |
| source |
Object |
optional |
|
| source.region |
String |
optional |
Webcheck's worker region |
| retry |
Object |
optional |
|
| retry.max |
Number |
optional |
Max webcheck's retry before mark as failed |
| retry.interval |
Number |
optional |
Webcheck's retry interval (ms) |
| alerts |
Object |
optional |
List of alerts (cf. Alert type) |
| application |
String |
optional |
Application's id |
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :webcheck |
String |
webcheck id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
missing parameters |
| 200 |
successfuly updated webcheck |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:webcheck |
|
webcheck id |