PUT /gui_app_framework/applications/{application_id}

Upgrades an application.

Upgrades an application.

Table 1. PUT /gui_app_framework/applications/{application_id} resource details
MIME Type

application/json

Table 2. PUT /gui_app_framework/applications/{application_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

application_id

path

Required

Number (Integer)

text/plain

Required - The application identifier.

Table 3. PUT /gui_app_framework/applications/{application_id} request body details
Parameter Data Type MIME Type Description Sample

package

zip

application/zip

Required - A zip file that contains the application's manifest and source code files.

null

Table 4. PUT /gui_app_framework/applications/{application_id} response codes
HTTP Response Code Unique Code Description

202

The request for an application upgrade was accepted.

404

1002

The application identifier could not be found.

409

33000

The current state of the application does not allow the requested action.

409

33001

This is a core QRadar app. You cannot upgrade or delete it.

409

33002

The application is currently locked by another request.

409

33006

The current state of the application instance does not allow the requested action.

409

33700

The application framework is currently disabled.

422

33004

This application can only be installed on an app node.

422

33102

The application zip file structure is invalid. Check that required folders are present.

422

33103

The manifest.json file is missing from the application zip file.

422

33104

The application manifest.json file does not conform to the manifest schema.

422

33105

The application manifest.json file contains duplicate keys.

422

33106

An error occurred while parsing the manifest.json file from the application zip file.

422

33201

An error occurred while processing the application RPM/Python dependencies.

422

33301

The UUID in the application manifest.json file does not match the existing UUID for this app.

422

33302

The application requested more memory than is currently available.

422

33303

The application manifest.json file contains an unsupported OAuth flow type.

422

33304

The application manifest.json file requested an invalid OAuth capability.

422

33307

The application manifest.json file contains an invalid required_capabilities entry.

500

33100

The uploaded application zip file could not be saved to disk.

500

33101

An error occurred while reading the application zip file.

500

33200

An error occurred while loading the application configuration properties file.

500

33202

An error occurred while generating the application Dockerfile.

500

33305

The updated application manifest.json file could not be saved to disk.

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

Upgrade status details:
  • application_id - Integer - Application identifier.
  • status - String
    • UPGRADING - the upgrade is in progress.
    • AUTH_REQUIRED - the upgrade is waiting for a response to an authorisation request. See /application_creation_task/{application_id}/auth for details.

Response Sample


{
    "application_id": 1001,
    "status": "CREATING"
}