REST API for Oracle Internet of Things Cloud Service

All REST Endpoints

Activation

Activate endpoints (devices, gateways and device applications) on the IoT network

There are two types of activation:

Direct Activation, the process by which devices and gateways connect to the IoT server directly through the Internet
Indirect Activation, the process by which device applications and devices that cannot connect to the IoT server directly connect through a gateway device

Activation is one of the endpoint lifecycle events for the endpoint.

Activate a Device: Method: post
Path: /iot/api/v2/activation/direct
Activate Devices Connected to Gateway: Method: post
Path: /iot/api/v2/activation/indirect/device
Retrieve Activation Parameters for a Device: Method: get
Path: /iot/api/v2/activation/policy

Authentication

Issue access tokens to successful applicants. See the Quick Start section for more information.

Authenticate with Server and Get Access Token: Method: post
Path: /iot/api/v2/oauth2/token

Export

This resource provides a set of methods to export IoT components from your Oracle IoT Cloud Service instance. The APIs of this category are deprecated and will be removed in upcoming versions.

Create an Export Request: Method: post
Path: /iot/api/v2/exports
Download the Exported Data: Method: get
Path: /iot/api/v2/exports/{request-id}/data
List the Export Requests: Method: get
Path: /iot/api/v2/exports
Retrieve the Details of an Export Request: Method: get
Path: /iot/api/v2/exports/{request-id}

Import

This resource provides a set of methods to import IoT components to your Oracle IoT Cloud Service instance. The APIs of this category are deprecated and will be removed in upcoming versions.

Create an Import Request: Method: post
Path: /iot/api/v2/imports
Execute an Import Request: Method: post
Path: /iot/api/v2/imports/{request-id}
List the Import Requests: Method: get
Path: /iot/api/v2/imports
Retrieve the Details of an Import Request: Method: get
Path: /iot/api/v2/imports/{request-id}

IoT Application

An Application is primarily a namespace. Each application should be, to the greatest extent possible, a fully-defined entity. It should define all the device models, integrations, analytics that the application needs in order to solve a business problem. Devices (directly and indirectly connected) are pooled at the global level (defined outside any application), but every application must define the scope of devices and formats they want to use via Device Models. As mentioned at the start of this section, applications are namespaces and must be as self-contained as possible. Some objects must be defined on a per-app basis, and some on a "global" basis (per-cloud-service). For example, Integrations are are always scoped within an app, they are never global since they only have meaning for a single app. Other objects such as devices are strictly global, although they can be referenced by an app.

Create a Device Model and associate it with the Application: Method: post
Path: /iot/api/v2/apps/{app-id}/deviceModels
Create a new Application: Method: post
Path: /iot/api/v2/apps
Delete Application by ID: Method: delete
Path: /iot/api/v2/apps/{app-id}
Invoke a Specific Action: Method: post
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/deviceModels/{devicemodel-id}/actions/{action-name}
Invoke DELETE Method on a Device: Method: delete
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/resources/{subResources}
Invoke GET Method on a Device: Method: get
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/resources/{subResources}
Invoke POST Method on a Device: Method: post
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/resources/{subResources}
Invoke PUT Method on a Device: Method: put
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/resources/{subResources}
Replace Application by ID: Method: post
Path: /iot/api/v2/apps/{app-id}
Replace the Values of Specific Attributes: Method: post
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/deviceModels/{devicemodel-id}/attributes/
Reset Setting: Method: delete
Path: /iot/api/v2/apps/{app-id}/settings/{group}/{name}
Reset Setting by Group: Method: post
Path: /iot/api/v2/apps/{app-id}/settings/{group}/reset
Retrieve Application Formats: Method: get
Path: /iot/api/v2/apps/{app-id}/formats
Retrieve Applications Count: Method: get
Path: /iot/api/v2/apps/count
Retrieve Available Settings: Method: get
Path: /iot/api/v2/apps/{app-id}/settings
Retrieve Details of an Application: Method: get
Path: /iot/api/v2/apps/{app-id}
Retrieve Information about Devices that Participate in an Application: Method: get
Path: /iot/api/v2/apps/{app-id}/devices
Retrieve Information about Multiple Device Models Consumed by The Application: Method: get
Path: /iot/api/v2/apps/{app-id}/deviceModels
Retrieve Number of Device Models Consumed by the Application.: Method: get
Path: /iot/api/v2/apps/{app-id}/deviceModels/count
Retrieve Number of Devices Consumed by the Application: Method: get
Path: /iot/api/v2/apps/{app-id}/deviceModels/devices/count
Retrieve Number of Devices of an Application that Implements a Specific Device Model: Method: get
Path: /iot/api/v2/apps/{app-id}/deviceModels/{urn}/devices/count
Retrieve Resources of a Device: Method: get
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/resources
Retrieve Setting: Method: get
Path: /iot/api/v2/apps/{app-id}/settings/{group}/{name}
Retrieve Settings that Belong to a Group: Method: get
Path: /iot/api/v2/apps/{app-id}/settings/{group}
Retrieve the Default Device Selection Group: Method: get
Path: /iot/api/v2/apps/{app-id}/deviceSelectionGroups/default
Retrieve the Latest Value of a Specific Attribute: Method: get
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/deviceModels/{devicemodel-id}/attributes/{attribute-name}
Retrieve the Latest Value of Attributes: Method: get
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/deviceModels/{devicemodel-id}/attributes
Retrieve the List of Applications: Method: get
Path: /iot/api/v2/apps
Retrieve the Metadata of an IoT Application: Method: get
Path: /iot/api/v2/apps/{app-id}/metadata
Retrieve the Number of Devices that can Participate in an Application: Method: get
Path: /iot/api/v2/apps/{app-id}/devices/count
Update Application Details by ID: Method: put
Path: /iot/api/v2/apps/{app-id}
Update Default Device Selection Group: Method: post
Path: /iot/api/v2/apps/{app-id}/deviceSelectionGroups/default
Update Multiple Groups of Settings: Method: put
Path: /iot/api/v2/apps/{app-id}/settings
Update Setting: Method: put
Path: /iot/api/v2/apps/{app-id}/settings/{group}/{name}
Update Settings in the Group: Method: put
Path: /iot/api/v2/apps/{app-id}/settings/{group}
Update the Metadata of an IoT Application: Method: post
Path: /iot/api/v2/apps/{app-id}/metadata
Update the Value of Specific Attributes: Method: put
Path: /iot/api/v2/apps/{app-id}/devices/{device-id}/deviceModels/{devicemodel-id}/attributes/{attribute-name}

IoT Application Exploration

IoT Application Exploration APIs are deprecated and may be removed in a future release. The APIs work with Exploration Sources to facilitate real time event stream processing. These REST APIs allow users to create and manage IoT Application Explorations within IoT Cloud Service. Additionally, these REST APIs allow the creation, management, and association of IoT message formats to these Explorations.

Create a Message Format and Associate with an Exploration: Method: post
Path: /iot/api/v2/apps/{app-id}/explorations
Create a New Exploration Source: Method: post
Path: /iot/api/v2/apps/{app-id}/explorationSources
Delete the Exploration Source: Method: delete
Path: /iot/api/v2/apps/{app-id}/explorationSources/{explorationsource-id}
Delete the Message Format and Association with an Exploration: Method: delete
Path: /iot/api/v2/apps/{app-id}/explorations/{explorationID}
Delete the Message Format Locally (from IoT database only): Method: delete
Path: /iot/api/v2/apps/{app-id}/explorations/{explorationID}/{urn}
Replace Exploration Source Details Specified by ID: Method: post
Path: /iot/api/v2/apps/{app-id}/explorationSources/{explorationsource-id}
Retrieve an Exploration Source: Method: get
Path: /iot/api/v2/apps/{app-id}/explorationSources/{explorationsource-id}
Retrieve Exploration Sources of an Application: Method: get
Path: /iot/api/v2/apps/{app-id}/explorationSources
Retrieve the List of Message Format Associations: Method: get
Path: /iot/api/v2/apps/{app-id}/explorations
Retrieve the Message Format Association with an Exploration: Method: get
Path: /iot/api/v2/apps/{app-id}/explorations/{explorationID}
Update Exploration Source Details Specified by ID: Method: put
Path: /iot/api/v2/apps/{app-id}/explorationSources/{explorationsource-id}
Update the Message Format and Associate with an Exploration: Method: put
Path: /iot/api/v2/apps/{app-id}/explorations/{explorationID}

IoT Application Integration

An integration is an entity that an IoT Application utilizes to connect with an external enterprise application or cloud service (e.g. vertical business applications like BICS or JD Edwards etc.) An integration defines a set of streams to send data to an external application. A stream is essentially composed of a set of formats and optionally configuration & annotations. The type of integration defines the restriction on the number of streams that may be associated with an integration instance as well as specific restrictions on the composition of the streams themselves.

Create New Integration: Method: post
Path: /iot/api/v2/apps/{app-id}/integrations/
Create or Update an Integration Root Certificate, For the given Integration ID: Method: put
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate
Delete Integration, Specified by ID: Method: delete
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}
Delete the Root Certificate of an Integration, specified by ID: Method: delete
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate
Invoke Synchronization: Method: post
Path: /iot/api/v2/apps/{app-id}/integrations/{id}/sync/now
Retrieve Integration Count: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/count
Retrieve Integration Details: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}
Retrieve Integration Root Certificate: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/certificate
Retrieve messages of a specified Integration in an Application specified by ID: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}/messages
Retrieve the Last Synchronization Details: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/{id}/sync/
Retrieve the List of Integrations: Method: get
Path: /iot/api/v2/apps/{app-id}/integrations/
Update Integration Specified by ID: Method: put
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}
Update Integration, specified by ID: Method: post
Path: /iot/api/v2/apps/{app-id}/integrations/{integration-id}

IoT Device Models

Device Models

Check a Device Model Update: Method: post
Path: /iot/api/v2/deviceModels/{urn}/updateCheck
Create a Device Model: Method: post
Path: /iot/api/v2/deviceModels
Delete a Device Model: Method: delete
Path: /iot/api/v2/deviceModels/{urn}
Retrieve a Device Model: Method: get
Path: /iot/api/v2/deviceModels/{urn}
Retrieve a list of entities depending on this device model: Method: get
Path: /iot/api/v2/deviceModels/{urn}/dependingEntities
Retrieve Count of Device Models: Method: get
Path: /iot/api/v2/deviceModels/count
Retrieve Device Models: Method: get
Path: /iot/api/v2/deviceModels
Retrieve Formats of the Device Model: Method: get
Path: /iot/api/v2/deviceModels/{urn}/formats
Update a Device Model: Method: put
Path: /iot/api/v2/deviceModels/{urn}

IoT Device Resource

This resource provides set of operations and methods to manage devices, application for devices, metadata for devices and software resources for devices.

Create a Metadata for a Key of a Device Specified by its ID: Method: post
Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Create a New Device: Method: post
Path: /iot/api/v2/devices
Delete a Metadata Key for the Device with Specified ID: Method: delete
Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Delete Device Location: Method: delete
Path: /iot/api/v2/devices/{device-id}/location
Delete the Device by ID: Method: delete
Path: /iot/api/v2/devices/{device-id}
Retrieve a Metadata Key for the Device with Specified ID: Method: get
Path: /iot/api/v2/devices/{entity-id}/metadata/{key}
Retrieve Count of Common Device Metadata Keys: Method: get
Path: /iot/api/v2/devices/metadataTypes/count
Retrieve Count of Devices: Method: get
Path: /iot/api/v2/devices/count
Retrieve Device Activation Logs: Method: get
Path: /iot/api/v2/devices/{device-id}/logs/activation
Retrieve Device Details: Method: get
Path: /iot/api/v2/devices/{device-id}
Retrieve Information About Multiple Endpoints: Method: get
Path: /iot/api/v2/devices
Retrieve Information about the Device Location: Method: get
Path: /iot/api/v2/devices/{device-id}/location
Retrieve List of Common Device Metadata Keys: Method: get
Path: /iot/api/v2/devices/metadataTypes
Retrieve List of Devices Which Belong to: Method: get
Path: /iot/api/v2/devices/{device-id}/devices
Retrieve Metadata for Device with Specified ID: Method: get
Path: /iot/api/v2/devices/{entity-id}/metadata
Update a Device by ID: Method: post
Path: /iot/api/v2/devices/{device-id}
Update a Device Location with a New One: Method: put
Path: /iot/api/v2/devices/{device-id}/location
Update Device Information by ID: Method: put
Path: /iot/api/v2/devices/{device-id}
Update Device Location with New Values: Method: post
Path: /iot/api/v2/devices/{device-id}/location
Update or Delete Metadata for a Device by ID: Method: post
Path: /iot/api/v2/devices/{entity-id}/metadata

Messages

Messages is the REST endpoint used by a programmable device, such as a Gateway, to send messages to the Oracle IoT Cloud Service instance.

Send Messages: Method: post
Path: /iot/api/v2/messages

Monitoring

Retrieve status and metrics for an Oracle IoT Cloud Service Instance

Retrieve Availability Status: Method: get
Path: /iot/api/v2/monitoring/availability
Retrieve Availability Status of IoT Service: Method: get
Path: /iot/api/v2/monitoring/metrics/availability
Retrieve Device Count: Method: get
Path: /iot/api/v2/monitoring/metrics/registeredDeviceCount
Retrieve Dispatched Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchedMessageCount
Retrieve Dispatched Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchedMessageCount
Retrieve Dispatched Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchedMessageCount/
Retrieve Lost Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/dropCount
Retrieve Lost Message Count due to a Not Found error: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/notFoundCount
Retrieve Lost Message Count due to authorization failure: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount
Retrieve Lost Message Count due to bad request: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/badRequestCount
Retrieve Lost Message Count due to connection reset: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount
Retrieve Lost Message Count due to other errors: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount
Retrieve Lost Message Count due to read timeout: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount
Retrieve Lost Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/dropCount
Retrieve Lost Message Count for an app_id due to authorization failure: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount
Retrieve Lost Message Count for an app_id due to bad request: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/badRequestCount
Retrieve Lost Message Count for an app_id due to connection reset: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount
Retrieve Lost Message Count for an app_id due to not found error: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/notFoundCount
Retrieve Lost Message Count for an app_id due to other errors: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount
Retrieve Lost Message Count for an app_id due to read timeout: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount
Retrieve Lost Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/dropCount/
Retrieve Lost Message Count for an integrationID and app_id due to authorization failure: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/authorizationFailureCount/
Retrieve Lost Message Count for an integrationID and app_id due to bad gateway: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount/
Retrieve Lost Message Count for an integrationID and app_id due to connection reset: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/connectionResetCount/
Retrieve Lost Message Count for an integrationID and app_id due to not found error: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/notFoundCount/
Retrieve Lost Message Count for an integrationID and app_id due to other errors: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/otherErrorCount/
Retrieve Lost Message Count for an integrationID and app_id due to read timeout: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/readTimeoutCount/
Retrieve Message Count due to bad gateway: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount
Retrieve Message Count due to server error: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount
Retrieve Message Count due to Service unavailability: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount
Retrieve Message Count for an app_id due to server error: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount
Retrieve Message Dispatch Latency: Method: get
Path: /iot/api/v2/monitoring/metrics/messageDispatchingLatency
Retrieve Message Dispatch Latency for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageDispatchingLatency
Retrieve Message Dispatch Latency for an integrationId and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/messageDispatchingLatency/
Retrieve Message Processing Latency: Method: get
Path: /iot/api/v2/monitoring/metrics/messageProcessingLatency
Retrieve Message Processing Latency for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageProcessingLatency
Retrieve Metric Data: Method: get
Path: /iot/api/v2/monitoring/metrics/{metricName}
Retrieve Number of Authentication Failures due to Bad Tokens: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/badTokenCount
Retrieve Number of Authentication Failures due to Session Expiry: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/expiredSessionCount
Retrieve Number of Devices that Failed Authentication: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount/deviceCount
Retrieve Number of Online Devices: Method: get
Path: /iot/api/v2/monitoring/metrics/onlineDeviceCount
Retrieve Processed Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/processedMessageCount
Retrieve Processed Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/processedMessageCount
Retrieve Retried/Lost Message Count: Method: get
Path: /iot/api/v2/monitoring/metrics/dispatchFailedMessageCount
Retrieve Retried/Lost Message Count for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount
Retrieve Retried/Lost Message Count for an app_id due to bad gateway: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/badGatewayCount
Retrieve Retried/Lost Message Count for an app_id due to service unavailability: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount
Retrieve Retried/Lost Message Count for an integrationID and app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/
Retrieve retried/Lost Message Count for an integrationID and app_id due to server error: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/serverErrorCount/
Retrieve Retried/Lost Message Count for an integrationID and app_id due to service unavailibility: Method: get
Path: /iot/api/v2/apps/{app_id}/integrations/{integrationID}/monitoring/metrics/dispatchFailedMessageCount/serviceUnavailableCount/
Retrieve Total Number of Alert Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/alertCount
Retrieve Total Number of Alert Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/alertCount
Retrieve Total Number of Authentication Failures: Method: get
Path: /iot/api/v2/monitoring/metrics/authenticationFailureCount
Retrieve Total Number of Inbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume/inbound
Retrieve Total Number of Inbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume/inbound
Retrieve Total Number of Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume
Retrieve Total Number of Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume
Retrieve Total Number of Outbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/messageVolume/outbound
Retrieve Total Number of Outbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/messageVolume/outbound
Retrieve Total Size of all the Inbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages/inbound
Retrieve Total Size of all the Inbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages/inbound
Retrieve Total Size of all the Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages
Retrieve Total Size of all the Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages
Retrieve Total Size of all the Outbound Messages: Method: get
Path: /iot/api/v2/monitoring/metrics/dataVolume/messages/outbound
Retrieve total size of all the Outbound Messages for an app_id: Method: get
Path: /iot/api/v2/apps/{app_id}/monitoring/metrics/dataVolume/messages/outbound

Provisioner

This resource provides a set of operations and methods to get provisioning information for devices and enterprise integrations on the IoT network. Provisioning information includes attributes such as server URI, sharedSecret, endpointId, and trustAnchor certificates that are required to be provisioned on the device and enterprise clients that connect to the IoT network.

Provisioning File for a Single Device: Method: post
Path: /iot/api/v2/provisioner/device
Provisioning File for Devices Registered as a Batch: Method: post
Path: /iot/api/v2/provisioner/registration
Provisioning File for Integration: Method: post
Path: /iot/api/v2/provisioner/integration
Retrieve the Storage Service Location and Authorization Token: Method: get
Path: /iot/api/v2/provisioner/storage

Registration

Perform batch registration of the devices. To register a single device, go to IoT Device Resource and see how to use the APIs.

Delete a Batch Registration Request: Method: delete
Path: /iot/api/v2/registrations/{registration-id}
List Registration Requests: Method: get
Path: /iot/api/v2/registrations
Retrieve Failed Registration Entries: Method: get
Path: /iot/api/v2/registrations/{registration-id}/failedEntries
Retrieve Ignored Registration Entries: Method: get
Path: /iot/api/v2/registrations/{registration-id}/ignoredEntries
Retrieve Information about a Batch Registration Request: Method: get
Path: /iot/api/v2/registrations/{registration-id}
Retrieve Information in a Registration File Format: Method: get
Path: /iot/api/v2/registrations/{registration-id}/registrationFile
Retrieve Successfully Registered Entries: Method: get
Path: /iot/api/v2/registrations/{registration-id}/successEntries
Start the Registration Process: Method: post
Path: /iot/api/v2/registrations/{registration-id}
Upload a Registration File: Method: post
Path: /iot/api/v2/registrations

Resource Request

This resource provides set methods related to resource requests

Retrieve Resource Request Response: Method: get
Path: /iot/api/v2/requests/{requestId}/response
Retrieve Resource Request Status: Method: get
Path: /iot/api/v2/requests/{requestId}

System Configuration

This resource manages cloud server settings.

Reset Setting: Method: delete
Path: /iot/api/v2/settings/{group}/{name}
Reset Setting by Group: Method: post
Path: /iot/api/v2/settings/{group}/reset
Retrieve Available Settings: Method: get
Path: /iot/api/v2/settings
Retrieve Setting: Method: get
Path: /iot/api/v2/settings/{group}/{name}
Retrieve Settings that Belong to a Group: Method: get
Path: /iot/api/v2/settings/{group}
Update Multiple Groups of Settings: Method: put
Path: /iot/api/v2/settings
Update Setting: Method: put
Path: /iot/api/v2/settings/{group}/{name}
Update Settings in the Group: Method: put
Path: /iot/api/v2/settings/{group}