Get Device Variables

9min
Returns metadata variables assigned to a device
GET
Request
Query Parameters
product
required
String
Product short code
hardware_id
required
String
Unique hardware ID generated for the client device
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
import requests

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

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

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

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

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

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
Responses
200
404
[
    {
        "id": 2155,
        "value": "t",
        "variable": "0",
        "created_at": "2021-10-13T10:57:25.000Z",
        "device_id": 1630390110774029
    },
    {
        "id": 2156,
        "value": "e",
        "variable": "1",
        "created_at": "2021-10-13T10:57:25.000Z",
        "device_id": 1630390110774029
    }
]
[
    {
        "id": 2155,
        "value": "t",
        "variable": "0",
        "created_at": "2021-10-13T10:57:25.000Z",
        "device_id": 1630390110774029
    },
    {
        "id": 2156,
        "value": "e",
        "variable": "1",
        "created_at": "2021-10-13T10:57:25.000Z",
        "device_id": 1630390110774029
    }
]
﻿
Schema
Request Query Parameters
TypeScript
JSON
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,
}
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 Body
TypeScript
JSON
type GetDeviceVariablesResponseBody = ({
    variable: string,
    value: string | number | boolean,
    device_id: number,
    created_at: number, // UNIX Timestamp in milliseconds, e.g. 1737128752745
})[];
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:
TypeScript
{
  status: number,
  code: string,
  message: string
}
{
  status: number,
  code: string,
  message: string
}
﻿
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
﻿
Updated 17 Jan 2025
Did this page help you?
Device Variables
Track Device Variables