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)

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

javascript (fetch)

python

ruby

---

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: number, // UNIX Timestamp in milliseconds, e.g. 1737128752745
})[];

---

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