Methods
(async, route) create(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/applications |
Create an application
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| name |
String |
|
| domains |
Object |
Array of string with domains |
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 application |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(async, route) delete(:id, :application)
Route:
| Method | Path |
|---|
| DELETE |
/api/bucket/:id/applications/:application |
Delete an application
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :application |
String |
application id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 204 |
successfuly deleted application |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:application |
|
application id |
(async, route) get(:id, :application)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/applications/:application |
Get an application
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 |
| :application |
String |
application id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 404 |
application not found |
| 200 |
successfuly retrieved application |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:application |
|
application id |
(async, route) getPreview(:id, :application)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/applications/:application/preview |
Get a screenshot for application
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 |
| :application |
String |
application id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 404 |
preview not found |
| 200 |
successfuly retrieved application screenshot |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:application |
|
application id |
(async, route) getReports(:id, :application)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/applications/:application/report |
Get a report (lighthouse + requests size) for application
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 |
| :application |
String |
application id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 404 |
report not found |
| 200 |
successfuly retrieved application report |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:application |
|
application id |
(async, route) list(:id)
Route:
| Method | Path |
|---|
| GET |
/api/bucket/:id/applications |
List applications from statuses and applications
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 applications |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(async, route) update(:id, :application)
Route:
| Method | Path |
|---|
| PUT |
/api/bucket/:id/applications/:application |
Update an application
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| name |
String |
optional |
|
| domains |
Object |
optional |
|
Header Parameters:
| Name |
Type |
Description |
| Authorization |
String |
bearer access token issued for the user |
Route Parameters:
| Name |
Type |
Description |
| :id |
String |
bucket id |
| :application |
String |
application id |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
missing parameters |
| 200 |
successfuly updated application |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
:application |
|
application id |