POST /gui_app_framework/applications/{application_id}
Updates an application.
Updates an application.
- status:
- Supply value RUNNING to start a stopped application instance.
- Supply value STOPPED to stop a running application instance.
- memory: change the amount of memory allocated to the application instance.
- oauth_user_id: change the authorized user associated with the application instance.
- security_profile_id: change the security profile associated with the application instance.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
application_id |
path |
Required |
Number (Integer) |
text/plain |
Required - The application instance identifier. |
status |
query |
Optional |
String |
text/plain |
The status to set: RUNNING or STOPPED. |
memory |
query |
Optional |
Number (Integer) |
text/plain |
The amount of memory (MB) to allocate to the application instance. |
oauth_user_id |
query |
Optional |
Number (Integer) |
text/plain |
The authorized user ID to set. |
security_profile_id |
query |
Optional |
Long |
text/plain |
The security profile ID to associate with the application instance. |
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. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The application has been successfully updated. |
|
404 |
33901 |
The application instance could not be found. |
409 |
33000 |
The current state of the application does not allow the requested action. |
409 |
33006 |
The current state of the application instance does not allow the requested action. |
409 |
33402 |
The application image does not exist in the docker registry |
409 |
33600 |
The application does not have an associated OAuth user. |
409 |
33602 |
The supplied OAuth user does not have the capabilities required by the application. |
409 |
33700 |
The application framework is currently disabled. |
409 |
33703 |
The current state of the system hosts file does not allow the requested action. |
409 |
33705 |
The requested action is not allowed for the application instance host type. |
422 |
33302 |
The application requested more memory than is currently available. |
422 |
33500 |
A valid query parameter must be supplied to this API request. |
422 |
33501 |
An invalid value was supplied for the status parameter. |
422 |
33502 |
No more than one query parameter can be supplied at a time to this API request. |
422 |
33601 |
The supplied OAuth user does not exist. |
422 |
33650 |
The supplied security profile does not exist. |
422 |
33651 |
The supplied security profile is invalid as you can only change from the admin security profile id to null or vice versa. |
422 |
33652 |
There is already an instance with the supplied security profile with the same app definition |
422 |
33704 |
The application is not supported on this QRadar release. |
422 |
33706 |
The requested memory is less than the minimum memory specified by the application definition. |
500 |
33306 |
An error occurred while parsing the copy of the app manifest stored in the database. |
500 |
1020 |
The request could not be completed. |
Response Description
Application details, 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,
"image": "String",
"installed_by": "String",
"installed_on": 42,
"managed_host_id": 42,
"manifest": {
"add_app_capability": "String",
"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",
"location": "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"
}
],
"image": "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",
"uninstall_hooks": [
{
"description": "String",
"documentation_url": "String",
"last_instance_only": "String",
"rest_method": "String"
}
],
"uuid": "String",
"version": "String"
},
"security_profile_id": 42
}