Jump to Content
Guides
API Reference
Release Notes
v1.0
API Reference
v1.0
Guides
API Reference
Release Notes
Account and Authentication
All
Pages
Start typing to search…
JUMP TO
Cloud API Reference
Getting Started
Introduction
Account and Authentication
How to Make API Requests
Sign In
post
Device Service
Registration & Setup
Get registrable device
get
Register device
post
Unregister device
del
Register device to user
put
Transfer registration
put
Unregister device from user
put
Templates
Create template
post
Get templates
get
Get template
get
Update template
put
Create template properties
post
Devices
Get devices
get
Get associated devices by email
get
Search devices
get
Get device by ID
get
Rename device by ID
put
Get device by DSN
get
Rename device by DSN
put
Get device address
get
Update device address
put
Delete device address
del
Update device location
post
Get commands by DeviceID
get
Get commands by DSN
get
Factory reset device
put
Properties
Create datapoints
post
Create datapoint by DSN
post
Create datapoint by device ID
post
Get datapoint by DSN
get
Get datapoints by DSN
get
Get datapoint by device ID
get
Get property by DSN
get
Get properties by DSN
get
Get property by device ID
get
Get properties by device ID
get
Create message datapoint by DSN
post
User Roles
Enable role on device
post
Associate role user
put
Get device role labels
get
Get associated devices by role
get
Disassociate a role label to a device
put
Get role label
get
Update role label
put
Delete role label
del
Schedules
Create a schedule
post
Get schedules for user
get
Get schedule
get
Clear schedule
put
Get schedules by Device ID
get
Get schedule by name
get
Update schedule
put
Create schedule action
post
Get schedule actions
get
Get schedule action by name
get
Get schedule action by ID
get
Update schedule action
put
Delete schedule action
del
Notifications
Create notification
post
Get notification
get
Get notifications
get
Get all notifications
get
Update notification
put
Delete notification
del
Create notification app
post
Get notification app
get
Get notification apps
get
Update notification app
put
Delete notification app
del
Triggers
Create trigger
post
Get trigger
get
Get device triggers
get
Get triggers
get
Get all triggers
get
Update trigger
put
Delete trigger
del
Create trigger app
post
Get trigger apps
get
Get trigger app
get
Update trigger app
put
Delete trigger apps by ID
del
Groups
Create group
post
Add device to group
post
Get group
get
Get groups
get
Rename group
put
Remove device from group
del
Delete group by ID
del
Create datapoints in group
post
Create datapoint in group
post
Get datapoints in group
get
Connections
Get connection history
get
Get LAN data
get
Gateway & Nodes
Get nodes by device ID
get
Get nodes by DSN
get
Identify Zigbee node
put
Open registration window
post
Metadata
Create device metadatum
post
Get device metadatum
get
Get device metadata
get
Update device metadata
put
Delete device metadatum
del
Timezones
Get timezone
get
Get device timezone
get
Set device timezone
put
Virtual Devices
Create virtual device
post
Get virtual devices
User Service
User Accounts
SSO sign in
post
Token Validation
Get end users
get
Get users by role
get
Delete user account
del
Create role
post
Assign role
put
Revoke role
put
Assign label
put
Revoke label
put
Get role user
get
Create role user
post
Associate role user
put
Disassociate role user
put
Create associated user
post
Disassociate user
put
Get users by label
get
Get users by OEM
get
Update user contact
put
Delete user contact
del
Get OEM users
get
Create user account
post
Update user account
put
Delete user account
del
Send confirmation instruction
post
Confirm user account
put
Get user profile
get
Reset password
post
Reset password of API caller
put
Refresh token
post
Sign in
post
Sign out
post
Update email
put
Get user by ID
get
Get user by universal user ID
get
Metadata
Create user metadatum
post
Get user metadatum
get
Get user metadata
get
Update user metadatum
put
Delete user metadatum
del
Sharing
Create share
post
Get share
get
Get shares
get
Get received shares
get
Update share
put
Delete share by User ID
del
Delete share
del
Contacts
Create contact
post
Get contacts
get
Get contact details
get
Update contact
put
Delete contact
del
Create user contact
post
Get user contact
get
Get user contacts
get
Partner Role Accessible Properties
Get properties
get
Configure properties
post
Edit property permissions
put
Delete properties
del
Firebase Dynamic Linking
Create Firebase configuration
post
Update Firebase configuration
put
Delete Firebase configuration
del
Get Firebase configuration
get
Get clients
get
OEM
Get OEM
get
Get OEMs
get
Factory Proxy Service
Factory Proxy Service
Reserve DSNs
post
Update device manufacturer info
put
Update device OEM
put
IoT Command Center
ICC File
Create file record
post
Get file records
get
Get file record
get
Delete file record
del
Download file
get
Upload file
put
Update file transfer record
put
ICC Filter
Create filter
post
Get filters
get
Preview filter
post
Get filter
get
Update filter
put
Copy filter
post
Delete filter
del
Export DSNs
get
Refresh device list
post
Get devices by filter
get
ICC Job
Create job
post
Get jobs
get
Get job
get
Update job
put
Delete job
del
Cancel job
post
Search jobs
get
Copy job
post
Get device status
get
Get device snapshot
get
Set OTA action
post
Get OTA action
get
Update OTA job by job ID
put
Set properties for job
post
Create job schedule
post
Get properties for job
get
Get schedule
get
Edit schedule
put
Delete job schedule
del
Start job
post
Create job (Fast Track)
post
Set file property
post
Get file property
get
Get OTAs
get
Start OTA
post
Stop OTA
post
Get user consent
get
Decision for devices and device jobs
put
Decision for devices and device jobs - batch
put
Get all tasks
get
Get job report details
get
Remove OTA command
del
Retry selected devices
post
Download job report
get
Get device jobs
get
OTA Host Image
Create image record
post
Upload image
post
Get image records
get
Get OTA attributes
get
Update image record
put
Delete image record
del
Download image
get
Get host OTA image by ID
get
Update host OTA image by ID
put
Delete host OTA image by ID
del
OTA Module Image
Get module OTA image by ID
get
Update module OTA image by ID
put
Delete module OTA image by ID
del
Rule Service
Actions
Create action
post
Get action types
get
Create actions in bulk
post
Get action
get
Get actions
get
Update action
put
Delete action
del
Delete actions in bulk
del
Delete rule action
del
Delete rules actions by DSN
del
Delete rules actions by DSN & User UUID
del
Rules
Create rule
post
Create rules in bulk
post
Get rules
get
Get rule devices
get
Get rule
get
Update rule
put
Delete rule
del
Get rule actions
get
Delete rule
del
Delete rules in bulk
del
Get diagnostic states
get
Message Service
Destinations
Create destination
post
Create destinations in bulk
post
Get destinations
get
Get destination
get
Update destination
put
Delete destination
del
Delete destinations in bulk
del
Datastreams
Create datastream
post
Update datastream
put
Get datastreams
get
Get datastream
get
Delete datastream
del
Groups & Scenes
Groups and Scenes
Create group or scene (DEPRECATED)
post
Share group or scene
post
Add devices or child collections
post
Add attributes to collection
post
Retrieve collections
get
Retrieve collection
get
Get collections by "dsn" and "type"
get
Get custom attributes
get
Get owned shares
get
Get received shares
get
Update collection name
put
Update custom attributes
put
Update share
put
Delete collection
del
Delete all collections
del
Delete multiple collections
del
Remove specific devices or child collections
del
Remove custom attributes
del
Stop sharing collection
del
Remove devices
del
Groups
Create group or scene
post
Post datapoints to collection
post
Get last posted datapoints for a collection
get
Scenes
Activate scene manually (Tap-to-run)
post
Activate scene based on schedule_2
post
Activate scene based on schedule (DEPRECATED)
post
Update or set states
put
Enable/Disable scene automation
put
Activate scene based on countdown timer
put
Update schedule_2
put
Update schedule (DEPRECATED)
put
Delete schedule
del
Insights
Contract service
Get contract data
get
Get billing transaction count (Contracts Service)
get
Report service
Get report data
get
Get report metadata
get
Metering
Get billing transaction count (Metering Service)
get
Client MQTT
Create filter
post
Update filter
put
Get filters
get
Get filters by filter_uuid
get
Get associated topic
get
GET MQTT credentials
get
Delete filter
get
Dealer Service
Introduction
Create dealer
post
Update dealer
put
Get dealers
get
Get dealer by uuid
get
Search dealers
get
Get dealer roles
get
Delete dealer
del
Dealer user management
Create dealer user
post
Get dealer users
get
Search dealer users
get
End user management
Get end users of a dealer
get
Search end users of a dealer
get
Associate end user to a dealer
put
Device Management
Get devices tagged to a dealer
get
Assign dealer to group
put
Account and Authentication
Ask AI
