Methods
(route) delete(:id, :filename)
Route:
Method | Path |
DELETE |
/api/bucket/:id/data/profilings/:filename |
Delete profiling
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 |
:filename |
String |
filename |
Response:
Name |
Type |
Description |
. |
File |
return a file |
Response Code:
Type |
Description |
500 |
database error |
400 |
invalid parameters |
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |
:filename |
|
filename |
(route) download(:id, :filename)
Route:
Method | Path |
GET |
/api/bucket/:id/data/profilings/:filename/download |
Download profiling file
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 |
:filename |
String |
filename |
Response:
Name |
Type |
Description |
. |
File |
return a file |
Response Code:
Type |
Description |
500 |
database error |
400 |
invalid parameters |
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |
:filename |
|
filename |
(route) list(:id)
Route:
Method | Path |
POST |
/api/bucket/:id/data/profilings |
List profilings
Authentication
A authentication is needed to access this endpoint
Body Parameters:
Name |
Type |
Attributes |
Description |
apps |
Object |
optional |
|
servers |
Object |
optional |
|
from |
Object |
optional |
|
size |
Object |
optional |
|
type |
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 |
Response:
Name |
Type |
Description |
. |
Array |
array of object containing profilings |
Response Code:
Type |
Description |
500 |
database error |
200 |
succesfully retrieved data |
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |
(route) retrieve(:id, :filename)
Route:
Method | Path |
GET |
/api/bucket/:id/data/profilings/:filename |
Retrieve profiling file
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 |
:filename |
String |
filename |
Response:
Name |
Type |
Description |
. |
Object |
return profile data |
Response Code:
Type |
Description |
500 |
database error |
400 |
invalid parameters |
Parameters:
Name |
Type |
Description |
:id |
|
bucket id |
:filename |
|
filename |