License API
License Feature Check

9min
Checks a license device against a license feature. Once checked, this device will be connected to the feature. If a feature is a floating feature, device will also take one floating slot if available.
GET
Request
Query Parameters
hardware_id
required
String
Unique hardware ID generated for the client device
product
required
String
Product short code
feature
required
String
Feature code
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
Number
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"
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
curl --location --request GET '/api/v4/check_license_feature?hardware_id=string&product=string&feature=string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --request GET '/api/v4/check_license_feature?hardware_id=string&product=string&feature=string' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
{
    "id": 1698664358119314,
    "code": "f0",
    "name": "f0",
    "feature_type": "activation",
    "expiry_date": null,
    "metadata": {},
    "is_floating": false,
    "is_floating_cloud": true,
    "floating_timeout": 120,
    "floating_users": 8,
    "floating_in_use_devices": 1,
    "license_id": 1698662161371339
}
{
    "id": 1698664358119314,
    "code": "f0",
    "name": "f0",
    "feature_type": "activation",
    "expiry_date": null,
    "metadata": {},
    "is_floating": false,
    "is_floating_cloud": true,
    "floating_timeout": 120,
    "floating_users": 8,
    "floating_in_use_devices": 1,
    "license_id": 1698662161371339
}
﻿
Schema
Request Query Parameters
TypeScript
JSON
type LicenseFeatureCheckRequestParams = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string

}) & {

  // required properties:
  hardware_id: string
  product: string
  feature: string

  // optional properties:
  license_id?: number | undefined
}
type LicenseFeatureCheckRequestParams = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses:
  username: string

}) & {

  // required properties:
  hardware_id: string
  product: string
  feature: string

  // optional properties:
  license_id?: number | undefined
}
﻿
Response Body
TypeScript
JSON
type LicenseFeatureCheckResponseBody = {
    allow_negative_consumptions: boolean,
    allow_overages: boolean,
    allow_unlimited_consumptions: boolean,
    code: string,
    consumption_period: string,
    expiry_date: null | string,
    feature_type: string,
    id: number,
    is_floating_cloud: boolean,
    is_floating: boolean,
    license_id: number,
    max_consumption: number,
    max_overages: number,
    metadata: JSON,
    name: string,
    reset_consumption: boolean,
    total_consumptions: number,
}
type LicenseFeatureCheckResponseBody = {
    allow_negative_consumptions: boolean,
    allow_overages: boolean,
    allow_unlimited_consumptions: boolean,
    code: string,
    consumption_period: string,
    expiry_date: null | string,
    feature_type: string,
    id: number,
    is_floating_cloud: boolean,
    is_floating: boolean,
    license_id: number,
    max_consumption: number,
    max_overages: number,
    metadata: JSON,
    name: string,
    reset_consumption: boolean,
    total_consumptions: number,
}
﻿
Response contains a license feature fields :
floating_in_use_devices - number of devices currenly in use on this license feature license_id - id of the license
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
missing_headers (400): Some headers are missing
unknown_product (400): Provided product was not found
license_not_found (400): License with the provided license user not found
license_not_enabled (400): The license is not enabled
license_not_active (400): The license is not active
device_not_found (400): An active device matching the hardware_id not found
blacklisted (400): This device is blacklisted
invalid_license_feature_code (400): License feature code: ' + param + ' is invalid or not assigned    to the license.
floating_not_available (400): No available slots for floating license.
﻿
Updated 17 Jan 2025
Did this page help you?
License Check
Consumption