License API
Get Installation File

10min
Returns metadata on the installation file for a product
GET
Request
Query Parameters
product
required
String
Product short code
hardware_id
required
String
Unique hardware ID generated for the client device
license_key
optional
String
Required if product is key-based (see section below)
username
optional
String
Required if product is user based (see section below)
license_id
optional
String
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
version
optional
String
Version string, e.g. "1.0.0"
env
optional
String
Environment identifier, e.g. "win", "win32", "win64", "mac", "linux", "linux32", "linux64"
channel
optional
String
Channel identifier, e.g. "staging", "prod"
Header Parameters
Date
required
String
In RFC7231 format (see "License API Authorization"), eg.: Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See "License API Authorization" article
Curl
Node.js
JS
Python
Ruby
import requests

url = "/api/v4/installation_file?product=string&hardware_id=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/installation_file?product=string&hardware_id=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Responses
200
{
    "installation_file": "https://www.test.io/file/file.bin",
    "version": "1.0.2",
    "requires_version": null,
    "hash_md5": "",
    "release_date": "2021-04-30T00:00:00.000Z",
    "eula_link": null,
    "release_notes_link": null,
    "size": null,
    "channel": null
}
{
    "installation_file": "https://www.test.io/file/file.bin",
    "version": "1.0.2",
    "requires_version": null,
    "hash_md5": "",
    "release_date": "2021-04-30T00:00:00.000Z",
    "eula_link": null,
    "release_notes_link": null,
    "size": null,
    "channel": null
}
﻿
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
TypeScript
JSON
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,
}
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,
}
﻿
Response Body
TypeScript
JSON
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"
}
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"
}
﻿
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:
TypeScript
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
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
﻿
Updated 17 Jan 2025
Did this page help you?
Get Product Versions
List License Users for Customer