Skip to content

Install Version

To install a previously downloaded version of the engine, call the URI http(s)://<qie_server>:<management_api_port>/engine/installVersion with the following payload:

{
   "installVersion": <version>
}

Base JSON Payload Definition

Node Description
installVersion This is the version of QIE that should be installed, this version must already be downloaded, if it is not downloaded, then an error is thrown

The following response is received:

HTTP Status: 200

{
   "runningVersion": "<version>",
   "availableVersion": "<version>" | "None",
   "downloadedVersion": "<version>" | "None",
   "message": "<message>"
}
Node Description
runningVersion The version of the engine that is running
availableVersion The new version of the engine that is ready to be downloaded and installed. This could be "None" if there is no version available to download
downloadedVersion The new version of the engine that has been downloaded and is now ready to be installed. If there is no version downloaded ready to install then this value is "None"
message Status message for the install operation

If there is an error install command, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl command:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/engine/installVersion -d '{"installVersion":"5.0.0.0"}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/engine/installVersion -d "{\"installVersion\":\"5.0.0.0\"}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/engine/installVersion -Body '{"installVersion":"5.0.0.0"}' | Select-Object -Expand RawContent