Devices API Reference

This section describes the API endpoints for device management, including provisioning, activation, deactivation, and custom information operations. Endpoints are grouped by operation type for clarity.

1. Device Collection Operations

• List Devices GET /api/v1/devices

• Create Device POST /api/v1/devices

• Create WEDA Node Device POST /api/v1/devices?deviceType=weda-node

• Create General Device POST /api/v1/devices?deviceType=general-device

2. Device Detail Operations

• Update Device PATCH /api/v1/devices/{deviceId}

• Delete Device DELETE /api/v1/devices/{deviceId}

• Get Device GET /api/v1/devices/{deviceId}

3. Device Info & Customization

• Update Device Custom Info PUT /api/v1/devices/{deviceId}/custom-info
• Update Custom Info by Key PATCH /api/v1/devices/{deviceId}/custom-info/{key}
• Delete Device Custom Info DELETE /api/v1/devices/{deviceId}/custom-info
• Delete Custom Info by Key DELETE /api/v1/devices/{deviceId}/custom-info/{key}

• Get Device Custom Info GET /api/v1/devices/{deviceId}/custom-info

4. Device Sensors & Telemetry

• Update Telemetry Configs PATCH /api/v1/devices/{deviceId}/telemetry-configs?deviceType={weda-node,sub-node}
• Query:

Feature	API Endpoint	Use Case
List Device Sensors	GET /api/v1/devices/{deviceId}/sensors	Retrieves a list of sensors associated with a device.
List Device CPQs	GET /api/v1/devices/{deviceId}/cpqs	Retrieves a list of CPQs (custom property queries) associated with a device.
Get Telemetry Configs	GET /api/v1/devices/{deviceId}/telemetry-configs?deviceType={weda-node,sub-node}	Retrieves telemetry configurations for a device.

5. Device Activation & Deactivation

• Activate Device POST /api/v1/devices/{deviceId}:activate
• Deactivate Device POST /api/v1/devices/{deviceId}:deactivate

6. Organization-Scoped Device Operations

• Create Org Device POST /api/v1/orgs/{orgId}/devices

• Delete Org Device DELETE /api/v1/orgs/{orgId}/devices/{deviceId}

• List Org Devices GET /api/v1/orgs/{orgId}/devices

---

Last updated on Mar-31, 2026 | Version 1.0.0