Get Product Versions

Endpoint

• Method: GET

• Path: /api/v4/versions

• Description: Returns metadata on all available versions of a product.

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.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string

• Authorization (string)

Recommended headers

• Accept: application/json

Request

Query parameters

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

• product (required, string) — Product short code

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

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

• license_id (optional, number) — Ensures the action affects only the license with the specified ID (useful if multiple licenses for same product assigned to same user)

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

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

Examples

curl

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

nodejs

javascript (fetch)

python

ruby

Response

Array of version metadata objects:

type GetProductVersionsResponseBody = ({
  version: string,
  release_date: string, // Date string in full ISO 8601 format, e.g. "2024-09-27T23:30:48.016Z"
})[];

Example response body

[
  { "version": "1.0.0", "release_date": "2020-11-30T00:00:00.000Z" },
  { "version": "1.0.1", "release_date": "2020-11-30T00:00:00.000Z" },
  { "version": "1.0.2", "release_date": "2021-04-30T00:00:00.000Z" }
]

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
}