Get Device Variables

Returns metadata variables assigned to a device.

Endpoint

• Method: GET
• Path: /api/v4/get_device_variables
• Description: Returns metadata variables assigned to a device.

Authentication

See License API Authorization.

Required headers

• Date (string) — RFC7231 GMT date string
• Authorization (string)

Optional headers

• licensespring-tpm-signature (string) — TPM licensing signature and algorithm

  • licensespring-tpm-signature: algorithm="ES256",signature=""

Recommended headers

• Accept: application/json

Request

Query parameters

Required:

• product (string)
• hardware_id (string)

One of:

• license_key (string)
• username (string)

Optional:

• license_id (number)

Examples

curl

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

nodejs

var request = require('request');
var options = {
  method: 'GET',
  url: '/api/v4/get_device_variables?product=string&hardware_id=string&license_key=string',
  headers: {
    'Accept': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

javascript (fetch)

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("/api/v4/get_device_variables?product=string&hardware_id=string&license_key=string", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

python

import requests

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

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

response = requests.get(url, headers=headers)
print(response.text)

ruby

require "uri"
require "net/http"

url = URI("/api/v4/get_device_variables?product=string&hardware_id=string&license_key=string")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"

response = http.request(request)
puts response.read_body

---

Schema

Request schema (TypeScript)

type GetDeviceVariablesRequestParameters = {
  
  // 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,
}

Response schema (TypeScript)

type GetDeviceVariablesResponseBody = ({
    variable: string,
    value: string | number | boolean,
    device_id: number,
    created_at: string, // e.g. 2026-08-21T05:24:30.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
}

List of exceptions

unknown_product (400): Provided product was not found

license_not_found (400): License with the provided license user not found

license_not_active (400): The license is not active

license_not_enabled (400): The license is not enabled

device_not_found (400): An active device matching the hardware_id not found

blacklisted (400): This device is blacklisted

tpm_invalid_public_key (400): The TPM public key sent is not valid

tpm_signature_required (400): The TPM signature is missing from the header and TPM usage is enforced

tpm_signature_missmatch (400): The TPM signature/algorithm is not ES256 and the signature can't be verified against the TPM public key