Get a list of applications
1.API Name | Get a list of applications | Type | GET |
Description | The GET method is used to get a list of applications from the controller | ||
Resource URI | /apps | ||
Parameters-None | |||
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
apps | 1 | json | Application Info |
Create a new application
2.API Name | Create a new application | Type | POST |
Description | The POST method is used to create a new application on the controller | ||
Resource URI | /apps | ||
Parameters-None | |||
Request Body | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 201 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the node |
Get an application
3.API Name | Get an application | Type | GET |
Description | The GET method is used to get an application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 404 | ||
Response Parameters | |||
| App ID not found | |||
Update an existing application
4.API Name | Update an existing application | Type | PATCH |
Description | The PATCH method is used to update an existing application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body Parameters | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
type | 1 | string | Enum:[container,vm] |
name | 1 | string | The name of the application |
version | 1 | string | The version of the application |
vendor | 1 | string | The vendor of the application |
description | 1 | string | Description of the application |
cores | 1 | integer | The number of cores to allocate to the application |
memory | 1 | integer | The memory in MB to allocate to the application |
ports | 1 | complex | A list of port/protocol combinations to expose |
source | 1 | string | Source URI of the app |
Response Codes | 200 | ||
Application was updated | |||
Response Codes | 404 | ||
App ID not found | |||
Delete an existing application
5.API Name | Delete an existing application | Type | DELETE |
Description | The DELETE method is used to delete an existing application from the controller | ||
Resource URI | /apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 204 | ||
Application was deleted | |||
Response Codes | 404 | ||
App ID not found | |||
Get a list of applications on a node
6.API Name | Get a list of applications on a node | Type | GET |
Description | The GET method is used to get a list of applications on a node from the controller | ||
Resource URI | /nodes/{node_id}/apps | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
Request Body-None | |||
Response Codes | 200 | ||
Response Parameters | |||
Parameter Name | Cardinality | Type | Description |
apps | 1 | json | Application Info |
Response Codes | 404 | ||
Node ID not found | |||
Deploy an application to a node
7.API Name | Deploy an application to a node | Type | POST |
Description | The POST method is used to deploys an application to a node from the controller | ||
Resource URI | /nodes/{node_id}/apps | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
Request Body | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
Response Codes | 200 | ||
Deployed the application to the specified node | |||
Response Codes | 404 | ||
Node ID or app ID not found | |||
Get an application on a node
8.API Name | Get an application on a node | Type | GET |
Description | The GET method is used to get an application on a node from the controller | ||
Resource URI | /nodes/{node_id}/apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 200 | ||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
status | 1 | string | The status of the application Enum:[unknown, deploying, ready, starting, running, stopping, stopped, error] |
command | 1 | string | The lifecycle command for the application Enum:[start, stop, restart] |
Response Codes | 404 | ||
Node ID or app ID not found | |||
Update an application on a node
9.API Name | Update an application on a node | Type | PATCH |
Description | The PATCH method is used to update an application on a node from the controller | ||
Resource URI | /nodes/{node_id}/apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
app_id | 1 | string | The ID of the application |
Request Body | |||
Parameter Name | Cardinality | Type | Description |
id | 1 | string | The ID of the application |
status | 1 | string | The status of the application Enum:[unknown, deploying, ready, starting, running, stopping, stopped, error] |
command | 1 | string | The lifecycle command for the application Enum:[start, stop, restart] |
Response Codes | 200 | ||
Updated application for the specified node and application | |||
Response Codes | 404 | ||
Node ID or app ID not found | |||
Delete an application on a node
10.API Name | Delete an application on a node | Type | DELETE |
Description | The DELETE method is used to delete an application on a node from the controller | ||
Resource URI | /nodes/{node_id}/apps/{app_id} | ||
Parameters | |||
Parameter Name | Cardinality | Type | Description |
node_id | 1 | string | The ID of the node |
app_id | 1 | string | The ID of the application |
Request Body-None | |||
Response Codes | 204 | ||
Deleted the application for the specified node and application | |||
Response Codes | 404 | ||
Node ID or app ID not found | |||