Methods
(route) triggerAction(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/actions/trigger |
Trigger a custom action on a specific process
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| server_name |
String |
|
the name of the server |
| process_id |
Number |
optional |
the id of the process |
| app_name |
Number |
optional |
the name of the process |
| action_name |
String |
|
the name of the action to trigger |
| opts |
Object |
optional |
any specific options to be passed to the function |
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 |
| success |
Boolean |
succesully sended the action to PM2 |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully run the action |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) triggerPM2Action(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/actions/triggerPM2 |
Trigger a PM2 action
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Description |
| server_name |
String |
the name of the server |
| method_name |
String |
the name of the pm2 method to trigger |
| app_name |
String |
the name of the application |
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 |
| success |
Boolean |
succesully sended the action to PM2 |
Response Code:
| Type |
Description |
| 500 |
database error |
| 400 |
failed action |
| 200 |
succesfully run the action |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |
(route) triggerScopedAction(:id)
Route:
| Method | Path |
|---|
| POST |
/api/bucket/:id/actions/triggerScopedAction |
Trigger a scoped action
Authentication
A authentication is needed to access this endpoint
Body Parameters:
| Name |
Type |
Attributes |
Description |
| server_name |
String |
|
the name of the server |
| action_name |
String |
|
the name of the pm2 method to trigger |
| app_name |
String |
|
the name of the application |
| pm_id |
Number |
|
the id of the process |
| opts |
Object |
optional |
custom parameters to give to the 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:
| Name |
Type |
Description |
| . |
Object |
the action sended to the process |
Response Code:
| Type |
Description |
| 500 |
database error |
| 200 |
succesfully run the action |
Parameters:
| Name |
Type |
Description |
:id |
|
bucket id |