Get Installation File

Learn how to use the /api/v4/installation_file endpoint to retrieve installation file information for a specific license.

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.

Endpoint

• Method: GET

• Path: /api/v4/installation_file

• Description: Returns metadata on the installation file for a product.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string

• Authorization (string)

Recommended headers

• Accept: application/json

Request

Query parameters

• product (string) — required — Product short code

• hardware_id (string) — required — Unique hardware ID generated for the client device

• license_key (string) — optional — Required if product is key-based

• username (string) — optional — Required if product is user-based

• license_id (string) — optional — Ensures the action affects only the license with the specified ID

• version (string) — optional — Version string, e.g. "1.0.0"

• env (string) — optional — Environment identifier, e.g. "win", "win32", "win64", "mac", "linux", "linux32", "linux64"

• channel (string) — optional — Channel identifier, e.g. "staging", "prod"

Examples

curl

curl --location --request GET '/api/v4/installation_file?product=string&hardware_id=string&license_key=string' \
--header 'Accept: application/json' \
--header 'Date: string' \
--header 'Authorization: string'

nodejs

javascript (fetch)

python

ruby

Sample Response (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
}

Schema

Response schema (TypeScript)

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
}

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