Jump to Content

Guides API Reference Release Notes Discussions

v1.0

API Reference

v1.0Guides API Reference Release Notes Discussions

Cloud API Reference

Getting Started

Device Service

Registration & Setup
Templates
Devices
Properties
User Roles
Schedules
Notifications
Triggers
Groups
Connections
- Get connection historyget
- Get LAN dataget
Gateway & Nodes
Metadata
Timezones
Virtual Devices
- Create virtual devicepost
- Get virtual devices

User Service

User Accounts
Metadata
Sharing
Contacts
Partner Role Accessible Properties
Firebase Dynamic Linking
OEM
- Get OEMget
- Get OEMsget

Factory Proxy Service

Factory Proxy Service

IoT Command Center

ICC File
ICC Filter
ICC Job
OTA Host Image
OTA Module Image

Rule Service

Actions
Rules

Message Service

Destinations
Datastreams

Groups & Scenes

Groups and Scenes
Groups
- Post datapoints to collectionpost
Scenes

Insights

Contract service
- Get contract dataget
- Get billing transaction count (Contracts Service)get
Report service
- Get report dataget
- Get report metadataget
Metering
- Get billing transaction count (Metering Service)get

Dealer Service

Introduction
Create dealerpost
Update dealerput
Get dealersget
Get dealer by uuidget
Search dealersget
Get dealer rolesget
Delete dealerdelete
Dealer user management
End user management
Device Management
- Get devices tagged to a dealerget
- Assign dealer to groupput

Cloud API Reference

Getting Started

Device Service

Registration & Setup
Templates
Devices
Properties
User Roles
Schedules
Notifications
Triggers
Groups
Connections
- Get connection historyget
- Get LAN dataget
Gateway & Nodes
Metadata
Timezones
Virtual Devices
- Create virtual devicepost
- Get virtual devices

User Service

User Accounts
Metadata
Sharing
Contacts
Partner Role Accessible Properties
Firebase Dynamic Linking
OEM
- Get OEMget
- Get OEMsget

Factory Proxy Service

Factory Proxy Service

IoT Command Center

ICC File
ICC Filter
ICC Job
OTA Host Image
OTA Module Image

Rule Service

Actions
Rules

Message Service

Destinations
Datastreams

Groups & Scenes

Groups and Scenes
Groups
- Post datapoints to collectionpost
Scenes

Insights

Contract service
- Get contract dataget
- Get billing transaction count (Contracts Service)get
Report service
- Get report dataget
- Get report metadataget
Metering
- Get billing transaction count (Metering Service)get

Dealer Service

Introduction
Create dealerpost
Update dealerput
Get dealersget
Get dealer by uuidget
Search dealersget
Get dealer rolesget
Delete dealerdelete
Dealer user management
End user management
Device Management
- Get devices tagged to a dealerget
- Assign dealer to groupput

ICC File

This section lists the APIs related to ICC Files.

NOTE: From March 20, 2023, the .json suffix to the ICC API endpoints is deprecated.