Skip to main content

Overview

API device management gives you visibility into which devices are connecting to the platform through the API — and the ability to block any device that should no longer have access. Devices are registered automatically when they make API requests, so the device list is populated without any manual setup. This is useful for:
  • Identifying which devices are actively sending data
  • Blocking a device that has been lost, stolen, or is behaving unexpectedly
  • Reviewing when devices last communicated with the platform
  • Tracking device software and hardware details over time

How Devices Are Registered

Devices register themselves automatically when they make API requests. Each API request can include device identification headers, and the platform uses these to create and maintain device records:
HeaderInformation
Device IDUnique identifier for the device
ApplicationName of the application making the request
Application versionVersion of the application
Operating systemDevice OS (e.g. iOS, Android)
OS versionOperating system version
ManufacturerDevice manufacturer (e.g. Apple, Samsung)
ModelDevice model (e.g. iPhone 14, Galaxy S24)
There is no manual device registration process. If a device has never made an API request, it will not appear in the list.

Viewing Devices

Navigate to Settings > API Devices to see all registered devices. Each device in the list shows:
  • Name — either a custom name you’ve assigned, or the device identifier
  • Application — the application that registered the device
  • Manufacturer and model — hardware details (hidden on mobile)
  • Last activity — when the device last made an API request, or when it was blocked

Filtering the List

FilterDescription
NameSearch by device name or identifier
Blocked statusShow all devices, hide blocked devices, or show only blocked devices
Devices are sorted by most recently active first.

Viewing Device Details

Click on a device to view its full details:
FieldDescription
NameEditable custom name for the device
IdentifierThe unique device identifier (read-only)
ManufacturerDevice manufacturer
ModelDevice model
ApplicationApplication name
Operating systemOS name
Last data uploadWhen the device last sent data (POST request) to the platform
Last activeWhen the device last made any API request
Blocked atWhen the device was blocked (if applicable)

Renaming a Device

To make devices easier to identify, you can assign a custom name:
  1. Click on the device to open its details
  2. Edit the Name field
  3. Save the changes
The custom name replaces the device identifier in the list view, making it easier to distinguish between similar devices (e.g. “Box Office iPad - Main Entrance” instead of a technical identifier).

Blocking a Device

Blocking a device immediately prevents it from making any API requests. A blocked device receives an access denied response for every request until it is unblocked. To block a device:
  1. Click on the device to open its details
  2. Click Block device
  3. The device is blocked immediately
Blocking a device does not revoke any API tokens. The device itself is blocked — if the same token is used from a different device, those requests will still work. To fully revoke access, also revoke the associated API token.

Unblocking a Device

To restore access to a previously blocked device:
  1. Find the device (use the blocked status filter to show only blocked devices)
  2. Click on the device to open its details
  3. Click Unblock device
  4. The device can immediately resume making API requests

Device History

The platform tracks changes to a device’s software and hardware over time. When a device’s application version, operating system, or hardware details change, a history record is created. This helps you identify when devices were updated or replaced.