Skip to content

Download Version

Downloading a new version of the engine can take several minutes depending on internet speeds. To download a new version of the engine, call the URI http(s)://<qie_server>:<management_api_port>/engine/downloadVersion with the following payload:

{
   "downloadVersion": <version>
}

Base JSON Payload Definition

Node Description
downloadVersion This is the version of QIE that should be downloaded, if the availableVersion does not match this value 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 download operation

If there is an error with the download 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/downloadVersion -d '{"downloadVersion":"5.0.0.0"}'

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

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