Table of Contents
Get Started
- Quick Start
- Conventions
- Terminology
- Send Requests
- Authentication
- Collections
- Use cURL
- Status Codes
- Error Messages
Tasks
- Activation
- Authentication
- Export
- Import
- IoT Application
- Create a Device Model and associate it with the Application
- Create a new Application
- Delete Application by ID
- Invoke a Specific Action
- Invoke DELETE Method on a Device
- Invoke GET Method on a Device
- Invoke POST Method on a Device
- Invoke PUT Method on a Device
- Replace Application by ID
- Replace the Values of Specific Attributes
- Reset Setting
- Reset Setting by Group
- Retrieve Application Formats
- Retrieve Applications Count
- Retrieve Available Settings
- Retrieve Details of an Application
- Retrieve Information about Devices that Participate in an Application
- Retrieve Information about Multiple Device Models Consumed by The Application
- Retrieve Number of Device Models Consumed by the Application.
- Retrieve Number of Devices Consumed by the Application
- Retrieve Number of Devices of an Application that Implements a Specific Device Model
- Retrieve Resources of a Device
- Retrieve Setting
- Retrieve Settings that Belong to a Group
- Retrieve the Default Device Selection Group
- Retrieve the Latest Value of a Specific Attribute
- Retrieve the Latest Value of Attributes
- Retrieve the List of Applications
- Retrieve the Metadata of an IoT Application
- Retrieve the Number of Devices that can Participate in an Application
- Update Application Details by ID
- Update Default Device Selection Group
- Update Multiple Groups of Settings
- Update Setting
- Update Settings in the Group
- Update the Metadata of an IoT Application
- Update the Value of Specific Attributes
- IoT Application Exploration
- Create a Message Format and Associate with an Exploration
- Create a New Exploration Source
- Delete the Exploration Source
- Delete the Message Format and Association with an Exploration
- Delete the Message Format Locally (from IoT database only)
- Replace Exploration Source Details Specified by ID
- Retrieve an Exploration Source
- Retrieve Exploration Sources of an Application
- Retrieve the List of Message Format Associations
- Retrieve the Message Format Association with an Exploration
- Update Exploration Source Details Specified by ID
- Update the Message Format and Associate with an Exploration
- IoT Application Integration
- Create New Integration
- Create or Update an Integration Root Certificate, For the given Integration ID
- Delete Integration, Specified by ID
- Delete the Root Certificate of an Integration, specified by ID
- Invoke Synchronization
- Retrieve Integration Count
- Retrieve Integration Details
- Retrieve Integration Root Certificate
- Retrieve messages of a specified Integration in an Application specified by ID
- Retrieve the Last Synchronization Details
- Retrieve the List of Integrations
- Update Integration Specified by ID
- Update Integration, specified by ID
- IoT Device Models
- IoT Device Resource
- Create a Metadata for a Key of a Device Specified by its ID
- Create a New Device
- Delete a Metadata Key for the Device with Specified ID
- Delete Device Location
- Delete the Device by ID
- Retrieve a Metadata Key for the Device with Specified ID
- Retrieve Count of Common Device Metadata Keys
- Retrieve Count of Devices
- Retrieve Device Activation Logs
- Retrieve Device Details
- Retrieve Information About Multiple Endpoints
- Retrieve Information about the Device Location
- Retrieve List of Common Device Metadata Keys
- Retrieve List of Devices Which Belong to
- Retrieve Metadata for Device with Specified ID
- Update a Device by ID
- Update a Device Location with a New One
- Update Device Information by ID
- Update Device Location with New Values
- Update or Delete Metadata for a Device by ID
- Messages
- Monitoring
- Retrieve Availability Status
- Retrieve Availability Status of IoT Service
- Retrieve Device Count
- Retrieve Dispatched Message Count
- Retrieve Dispatched Message Count for an app_id
- Retrieve Dispatched Message Count for an integrationID and app_id
- Retrieve Lost Message Count
- Retrieve Lost Message Count due to a Not Found error
- Retrieve Lost Message Count due to authorization failure
- Retrieve Lost Message Count due to bad request
- Retrieve Lost Message Count due to connection reset
- Retrieve Lost Message Count due to other errors
- Retrieve Lost Message Count due to read timeout
- Retrieve Lost Message Count for an app_id
- Retrieve Lost Message Count for an app_id due to authorization failure
- Retrieve Lost Message Count for an app_id due to bad request
- Retrieve Lost Message Count for an app_id due to connection reset
- Retrieve Lost Message Count for an app_id due to not found error
- Retrieve Lost Message Count for an app_id due to other errors
- Retrieve Lost Message Count for an app_id due to read timeout
- Retrieve Lost Message Count for an integrationID and app_id
- Retrieve Lost Message Count for an integrationID and app_id due to authorization failure
- Retrieve Lost Message Count for an integrationID and app_id due to bad gateway
- Retrieve Lost Message Count for an integrationID and app_id due to connection reset
- Retrieve Lost Message Count for an integrationID and app_id due to not found error
- Retrieve Lost Message Count for an integrationID and app_id due to other errors
- Retrieve Lost Message Count for an integrationID and app_id due to read timeout
- Retrieve Message Count due to bad gateway
- Retrieve Message Count due to server error
- Retrieve Message Count due to Service unavailability
- Retrieve Message Count for an app_id due to server error
- Retrieve Message Dispatch Latency
- Retrieve Message Dispatch Latency for an app_id
- Retrieve Message Dispatch Latency for an integrationId and app_id
- Retrieve Message Processing Latency
- Retrieve Message Processing Latency for an app_id
- Retrieve Metric Data
- Retrieve Number of Authentication Failures due to Bad Tokens
- Retrieve Number of Authentication Failures due to Session Expiry
- Retrieve Number of Devices that Failed Authentication
- Retrieve Number of Online Devices
- Retrieve Processed Message Count
- Retrieve Processed Message Count for an app_id
- Retrieve Retried/Lost Message Count
- Retrieve Retried/Lost Message Count for an app_id
- Retrieve Retried/Lost Message Count for an app_id due to bad gateway
- Retrieve Retried/Lost Message Count for an app_id due to service unavailability
- Retrieve Retried/Lost Message Count for an integrationID and app_id
- Retrieve retried/Lost Message Count for an integrationID and app_id due to server error
- Retrieve Retried/Lost Message Count for an integrationID and app_id due to service unavailibility
- Retrieve Total Number of Alert Messages
- Retrieve Total Number of Alert Messages for an app_id
- Retrieve Total Number of Authentication Failures
- Retrieve Total Number of Inbound Messages
- Retrieve Total Number of Inbound Messages for an app_id
- Retrieve Total Number of Messages
- Retrieve Total Number of Messages for an app_id
- Retrieve Total Number of Outbound Messages
- Retrieve Total Number of Outbound Messages for an app_id
- Retrieve Total Size of all the Inbound Messages
- Retrieve Total Size of all the Inbound Messages for an app_id
- Retrieve Total Size of all the Messages
- Retrieve Total Size of all the Messages for an app_id
- Retrieve Total Size of all the Outbound Messages
- Retrieve total size of all the Outbound Messages for an app_id
- Provisioner
- Registration
- Delete a Batch Registration Request
- List Registration Requests
- Retrieve Failed Registration Entries
- Retrieve Ignored Registration Entries
- Retrieve Information about a Batch Registration Request
- Retrieve Information in a Registration File Format
- Retrieve Successfully Registered Entries
- Start the Registration Process
- Upload a Registration File
- Resource Request
- System Configuration