Device Management

Overview

This chapter covers the CRUD operations for physical devices, paginated queries, and linkage management with specific organizations.

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Create Device to Org	POST {Basic API URL}/api/v1/orgs/{orgId}/devices	Link or create a physical device to an organization
List Org Devices	GET {Basic API URL}/api/v1/orgs/{orgId}/devices	Get paginated list of devices in a specific organization
Get Device Sensors	GET {Basic API URL}/api/v1/devices/{deviceId}/telemetry-configs	Get telemetry configurations of a specific device
Update Device Sensors	PATCH {Basic API URL}/api/v1/devices/{deviceId}/telemetry-configs	Update telemetry configurations of a specific device
Activate Device	POST {Basic API URL}/api/v1/devices/{deviceId}:active	Activate a specific device
Deactivate Device	POST {Basic API URL}/api/v1/devices/{deviceId}:deactivate	Deactivate a specific device
Remove Device from Org	DELETE {Basic API URL}/api/v1/orgs/{orgId}/devices/{deviceId}	Remove device from an organization

Constraints & Limitations

General

• API access requires authentication with a valid token.
• Organization must exist before linking devices.
• Device must exist in the system before being linked to an organization.

Create

• deviceId is a MAC address on the physical device.
• hardware is the model of the device, e.g. "AIR-075".

Activate/Deactivate Device

• status can only be changed to active or deactivate.

Advanced Features

Device Operations

Operation	API	Description
Get Devices	GET https://{domain}/{tenantPath}/{srp}/api/v1/devices	Get three kinds of devices. Including devices, virtual devices, and sub devices.
Update Device	PATCH https://{domain}/{tenantPath}/{srp}/api/v1/devices/{deviceId}	Update device configuration.
Delete Device	DELETE https://{domain}/{tenantPath}/{srp}/api/v1/devices/{deviceId}	Permanently delete device by given deviceId.

Device Custom Info

Operation	API	Description
Get Device Capabilities	GET {Basic API URL}/api/v1/devices/{deviceId}/capabilities	Get hardware capabilities of a specific device
Add or update multiple custom info of a device	PUT {Basic API URL}/api/v1/devices/{deviceId}/custom-info	Add or update multiple custom info entries for a specific device
Get custom info of a device	GET {Basic API URL}/api/v1/devices/{deviceId}/custom-info	Get custom information of a specific device
Update a single custom info	PATCH {Basic API URL}/api/v1/devices/{deviceId}/custom-info/{key}	Update a single custom info entry for a specific device
Delete a single custom info	DELETE {Basic API URL}/api/v1/devices/{deviceId}/custom-info/{key}	Delete a single custom info entry for a specific device
Delete all custom info of a device	DELETE {Basic API URL}/api/v1/devices/{deviceId}/custom-info	Delete all custom info entries for a specific device

---

Last updated on Apr-8, 2026 | Version 1.0.0