GET /gui_app_framework/applications
Retrieve list of applications.
Retrieves a list of all installed applications.
Retrieved details include the application manifest and current status.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
Application list was retrieved. |
|
409 |
33700 |
The application framework is currently disabled. |
500 |
1020 |
The request could not be completed. |
Response Description
A list of application details. For a description of what each list entry contains, see GET /applications/{application_id}.
Response Sample
[
{
"application_definition_id": 42,
"application_state": {
"application_id": "String",
"error_messages": "String",
"error_messages_json": [
{
"code": "String",
"message": "String",
"source": "String"
}
],
"memory": 42,
"status": "String <one of: CREATING, UPGRADING, STARTING, RUNNING, STOPPING, STOPPED, DELETING, ERROR, UNKNOWN>"
},
"auth_client_user_id": 42,
"installed_by": "String",
"installed_on": 42,
"managed_host_id": 42,
"manifest": {
"app_id": 42,
"areas": [
{
"description": "String",
"id": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"text": "String",
"url": "String"
}
],
"authentication": {
"oauth2": {
"authorization_flow": "String",
"requested_capabilities": [
"String"
]
}
},
"configuration_pages": [
{
"description": "String",
"icon": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"text": "String",
"url": "String"
}
],
"console_ip": "String",
"custom_columns": [
{
"label": "String",
"named_service": "String",
"page_id": "String",
"required_capabilities": [
"String"
],
"rest_endpoint": "String"
}
],
"dashboard_items": [
{
"description": "String",
"required_capabilities": [
"String"
],
"rest_method": "String",
"text": "String"
}
],
"dependencies": {
"pip_directory": "String",
"rpms_directory": "String"
},
"description": "String",
"environment_variables": [
{
"name": "String",
"value": "String"
}
],
"fragments": [
{
"app_name": "String",
"location": "String",
"named_service": "String",
"page_id": "String",
"required_capabilities": [
"String"
],
"rest_endpoint": "String"
}
],
"gui_actions": [
{
"description": "String",
"groups": [
"String"
],
"icon": "String",
"id": "String",
"javascript": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"rest_method": "String",
"text": "String"
}
],
"load_flask": "String",
"log_level": "String",
"metadata_providers": [
{
"metadata_type": "String",
"rest_method": "String"
}
],
"multitenancy_safe": "String",
"name": "String",
"page_scripts": [
{
"app_name": "String",
"named_service": "String",
"page_id": "String",
"scripts": [
"String"
]
}
],
"resource_bundles": [
{
"bundle": "String",
"locale": "String"
}
],
"resources": {
"memory": 42
},
"rest_methods": [
{
"argument_names": [
"String"
],
"method": "String <one of: GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH>",
"name": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"url": "String"
}
],
"services": [
{
"autorestart": "String",
"autostart": "String",
"command": "String",
"directory": "String",
"endpoints": [
{
"error_mime_type": "String",
"http_method": "String",
"name": "String",
"parameters": [
{
"definition": "String",
"location": "String",
"name": "String"
}
],
"path": "String",
"request_mime_type": "String",
"response": {
"mime_type": "String"
}
}
],
"environment": "String",
"exitcodes": "String",
"name": "String",
"numprocs": 42,
"port": 42,
"priority": 42,
"process_name": "String",
"redirect_stderr": "String",
"serverurl": "String",
"startretries": 42,
"startsecs": 42,
"stderr_capture_maxbytes": "String",
"stderr_events_enabled": "String",
"stderr_logfile": "String",
"stderr_logfile_backups": 42,
"stderr_logfile_maxbytes": "String",
"stdout_capture_maxbytes": "String",
"stdout_events_enabled": "String",
"stdout_logfile": "String",
"stdout_logfile_backups": 42,
"stdout_logfile_maxbyte": "String",
"stopsignal": "String",
"stopwaitsecs": 42,
"umask": "String",
"user": "String",
"uuid": "String",
"version": "String"
}
],
"single_instance_only": "String",
"uuid": "String",
"version": "String"
},
"security_profile_id": 42
}
]