License API
Get Installation File
10min
product versions are returned up to the existing maintenance period or validity period on the license if those fields are not defined on a license, all versions will be returned by default schema request query parameters type installationfilerequestparameters = { // required parameters product string, hardware id string, // required for key based products license key string // required for user based products username string // optional parameters license id? string | undefined, version? string | undefined, env? string | undefined, channel? string | undefined, } json schema response body type installationfileresponsebody = { version string | null, environment string, hash md5 string | null, eula link string | null, release notes link string | null, size string | null, requires version string | null, channel string | null, installation file string | null, release date string | null, // date string in full iso 8601 format, e g "2024 09 27t23 30 48 016z" } json schema license authorization method there are two types of product licenses based on how the client application authorizes itself to interact with a license key based product licenses client interactions with the license have to be authorized using a license key user based product licenses the license has a corresponding "license user" instead of a license key client interactions with the license have to be authorized using a username errors if an error occurs, the response will have an http status code of 400 or higher, and the response body will contain an error description in the following format { status number, code string, message string } json schema { "$schema" "https //json schema org/draft/2020 12/schema", "type" "object", "properties" { "status" { "type" "number" }, "code" { "type" "string" }, "message" { "type" "string" } }, "required" \[ "status", "code", "message" ], "additionalproperties" false } list of exceptions license key or license user required (400) the license key or license user is missing active license required (400) an active license is required missing headers (400) some headers are missing missing parameters (400) some parameters are missing in the request { params } unknown product (400) provided product was not found license not found (400) license with the provided license user not found device not found (400) an active device matching the hardware id not found