Legacy Reference of Cloud Service APIsIoT Core

IoT Core

Last Updated on : 2023-06-15 04:47:09

IoT Core provides the fundamental device connection and device management. The secured and reliable connection between your IoT application and devices allows to monitor and to manage your IoT assets.

General Devices Control

API Name	URL
Get the specifications and properties of the device	GET:/v1.0/iot-03/devices/{device_id}/specification
Get the instruction set of the device	GET:/v1.0/iot-03/devices/{device_id}/functions
Get the instruction set of the category	GET:/v1.0/iot-03/categories/{category}/functions
Send commands	POST:/v1.0/iot-03/devices/{device_id}/commands
Get Category List	GET:/v1.0/iot-03/device-categories

General Devices status

API Name	URL
Get the status of a single device	GET:/v1.0/iot-03/devices/{device_id}/status
Get the latest status of multiple devices	GET:/v1.0/iot-03/devices/status
Get Status Set	GET:/v1.0/iot-03/categories/{category}/status

General Devices management

API Name	URL
Check whether a device is frozen	GET:/v1.0/iot-03/devices/{device_id}/freeze-state
Delete devices in batches	DELETE:/v1.0/iot-03/devices
Modify the device information	PUT:/v1.0/iot-03/devices/{device_id}
Delete a device	DELETE:/v1.0/iot-03/devices/{device_id}
Restore defaults	POST:/v1.0/iot-03/devices/{device_id}/actions/reset
Get the list of sub-devices	GET:/v1.0/iot-03/devices/{device_id}/sub-devices
Modify the frozen status of a device	PUT:/v1.0/iot-03/devices/{device_id}/freeze-state
Get Device Information	GET:/v1.1/iot-03/devices/{device_id}
Get Device Specification	GET:/v1.2/iot-03/devices/{device_id}/specification
Get Extended Properties in Bulk	GET:/v1.0/iot-03/devices/properties
Get Extended Properties	GET:/v1.0/iot-03/devices/{device_id}/properties
Query Protocols of Multiple Devices	GET:/v1.0/iot-03/devices/protocol
Get Device List	GET:/v1.3/iot-03/devices

Industry Asset Management

API Name	URL
Query assets based on id	GET:/v1.0/iot-02/assets
Delete Asset	DELETE:/v1.0/iot-02/assets/{asset_id}
Modify Asset	PUT:/v1.0/iot-02/assets/{asset_id}
Query Node Devices in Pages	GET:/v1.0/iot-02/assets/{asset_id}/devices
Paging query of sub-nodes under the current node	GET:/v1.0/iot-02/assets/{asset_id}/sub-assets
Query assets based on id	GET:/v1.0/iot-02/assets/{asset_id}
Add new asset	POST:/v1.0/iot-02/assets
Authorize Assets	POST:/v1.0/iot-03/assets/actions/user-authorized
Query the Authorized Assets	GET:/v1.0/iot-03/users/{uid}/assets
Authorize Assets to a User	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-authorized
Revoke a User's Asset Permissions	POST:/v1.0/iot-03/users/{uid}/actions/assets-unauthorized
Revoke Asset Permissions from a User	POST:/v1.0/iot-03/users/{uid}/actions/batch-assets-unauthorized
Query Cross-Level Sub-Assets	POST:/v1.1/iot-02/cross-level-sub-assets
Query Authorized User List	GET:/v1.0/iot-03/{asset_id}/authorized_users
Transfer Device	POST:/v1.0/iot-03/assets/devices/{device_id}/actions/transfer
Query and Sort Asset Sub-Node	GET:/v1.1/iot-02/assets/{asset_id}/sub-assets

Industry User Management

API Name	URL
Query User Information by User ID	GET:/v1.0/iot-02/users/{user_id}
Register User	POST:/v1.0/iot-02/users
Delete User	DELETE:/v1.0/iot-02/users/{user_id}
Reset Password	PUT:/v1.0/iot-02/users/reset-password
Query User Information on Pages	GET:/v1.1/iot-02/users
Modify User Information	PUT:/v1.1/iot-02/users/{user_id}
Query User Information by Username	GET:/v1.2/iot-02/users/{user_name}
Query User Information on Pages	GET:/v1.1/iot-02/users/page

Industry Device Registration

API Name	URL
Register a Bluetooth Device	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/register
Search for sub-devices	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/discover
Generate an `authKey` for Bluetooth Device Pairing	POST:/v1.0/iot-03/device-registration/single-bluetooth/auth-key
Activate a Bluetooth Device	POST:/v1.0/iot-03/device-registration/single-bluetooth/actions/active
Generate Pairing Token	POST:/v1.0/iot-03/device-registration/token
Stop Discovering Sub-devices	POST:/v1.0/iot-03/device-registration/devices/{device_id}/actions/stop-discover
Get the list of newly connected sub-devices	GET:/v1.0/iot-03/device-registration/devices/{device_id}/sub-devices
Query device activation result based on network distribution token	GET:/v1.1/iot-03/device-registration/tokens/{token}
Get Cloud System Time	GET:/v1.0/iot-03/cloud/system-time
Pair NB-IoT Device by Scanning QR Code	POST:/v1.0/iot-03/device-registration/qrcode-bind
Get the list of gateways under the asset	GET:/v1.0/iot-03/device-registration/assets/{asset_id}/gateways
Generate RSA Public Key for Bluetooth Pairing	POST:/v1.0/iot-03/device-registration/assets/{asset_id}/encryptions/rsa/public-key
Bind Device with Asset	POST:/v1.1/iot-02/device-bc-bind

Home Management

API Name	URL
Add Home	POST:/v1.0/home/create-home
Search Family	GET:/v1.0/homes/{home_id}
Modify Home	PUT:/v1.0/homes/{home_id}
Delete Family	DELETE:/v1.0/homes/{home_id}
Query the list of devices under the family	GET:/v1.0/homes/{home_id}/devices
Query Home Members	GET:/v1.0/homes/{home_id}/members
Add Home Member	POST:/v1.0/homes/{home_id}/members
Modify family member information	PUT:/v1.0/homes/{home_id}/members/{uid}
Delete Home Member	DELETE:/v1.0/homes/{home_id}/members/{uid}
Add Room	POST:/v1.0/homes/{home_id}/room
Query Room List	GET:/v1.0/homes/{home_id}/rooms
Delete Room	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}
Modify the room name	PUT:/v1.0/homes/{home_id}/rooms/{room_id}
Query family room equipment	GET:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Query user family list	GET:/v1.0/users/{uid}/homes
Add a device in the room	POST:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Modify Room Devices	PUT:/v1.0/homes/{home_id}/rooms/{room_id}/devices
Delete the device in the room under the family	DELETE:/v1.0/homes/{home_id}/rooms/{room_id}/devices

User Management

API Name	URL
Sync Users	POST:/v1.0/apps/{schema}/user
Get user information	GET:/v1.0/users/{uid}/infos
Get User List	GET:/v2.0/apps/{schema}/users
Undelete	POST:/v1.0/users/{uid}/actions/cancel-delete
Pre-delete the user account	POST:/v1.0/users/{uid}/actions/pre-delete

Application Management

API Name	URL
Get App Details	GET:/v1.0/apps/{schema}
Get App Information	GET:/v1.1/apps/{schema}

Network Management

API Name	URL
Get a list of sub-devices	GET:/v1.0/devices/{deviceId}/list-sub
Allow sub-devices to access the network	PUT:/v1.0/devices/{deviceId}/enabled-sub-discovery
Get the list of network equipment	GET:/v1.0/device/paring/tokens/{token}

Device Management

API Name	URL
Query Zigbee devices under the gateway	GET:/v1.0/devices/{deviceId}/sub-devices
Batch query equipment factory information	GET:/v1.0/devices/factory-infos
Get Device List	GET:/v1.0/devices
Modify device name	PUT:/v1.0/devices/{device_id}
Query device log	GET:/v1.0/devices/{device_id}/logs
Restore device factory settings	PUT:/v1.0/devices/{device_id}/reset-factory
Get device details	GET:/v1.0/devices/{deviceId}
Remove device	DELETE:/v1.0/devices/{deviceId}
Get User's Device List	GET:/v1.0/users/{uid}/devices
Get device status	GET:/v1.0/devices/{deviceId}/status
Get Device List v2	GET:/v2.0/devices
Batch query for the list of associated App user dimension devices	GET:/v1.0/iot-01/associated-users/devices
Delete User	DELETE:/v1.0/devices/{device_id}/users/{user_id}
Modify Device Members	PUT:/v1.0/devices/{device_id}/users/{user_id}
Query Device Members	GET:/v1.0/devices/{device_id}/users/{user_id}
Add Device Member	POST:/v1.0/devices/{device_id}/user
Query Member List by Device ID	GET:/v1.0/devices/{device_id}/users

Device Control

API Name	URL
Modify function point name	PUT:/v1.0/devices/{device_id}/functions/{function_code}
Control Device	POST:/v1.0/devices/{deviceId}/commands
Get the instruction set supported by the device	GET:/v1.0/devices/{deviceId}/functions
Get device specification attributes	GET:/v1.0/devices/{deviceId}/specifications
Get the instructions set by category	GET:/v1.0/functions/{category}
Get the instruction sets in bulk	GET:/v1.0/devices/functions
Get Device Specification Attribute	GET:/v1.1/devices/{device_id}/specifications

Next DocGeneral Device Capabilities