API Reference v3

API Reference v3

This API reference is organized by functional area, which generally equates to resource type.

Quick API Reference

This API reference is organized by functional area, which generally equates to resource type. It is important to know which protocol they are using because that determines if you are using the /v1, /v2 or /v3 resource path.

Subscriptions and Licenses

HTTP Request Description
GET /subscriptions/{acc} Retrieves the number of FOTA subscriptions for devices by account.
GET /licenses/{acc} Retrieves license status, including total number of licenses, number of assigned licenses, and a device list
POST /licenses/{acc}/assign Assigns licenses to devices. When licenses are assigned, the ThingSpace Software Management begins monitoring the devices for reachability.
POST /licenses/{acc/remove Removes licenses from devices. If the devices have not been upgraded, a license can be removed. When licenses are removed, the ThingSpace Software Management ends monitoring the devices for reachability.

Campaigns

HTTP Request Description
POST /campaigns/firmware/{acc} Schedule a firmware upgrade for a list of devices
GET /campaigns/{acc}/{campaignId} Get campaign level information on a software/firmware upgrade.

Reports

HTTP Request Description
GET /reports/{acc}campaigns/{campaignID}/devices Get device-level status for a campaignDevices

Devices

HTTP Request
Description
GET /devices/{acc} Get account devices information such as reported firmware on the device..

Firmware

HTTP Request Description
GET /firmware/{acc} Get a list of available firmware.
PUT /firmware/{acc}/{deviceId} Get the reported firmware from the device management server for a particular device.

Callbacks

HTTP Request Description
POST /callbacks/{acc} Register a callback listener
PUT /callbacks/{acc} Update callback listener
DELETE /callbacks/{account}/name/{service} Stop receiving callbacks

GET /callbacks/{acc} Get registered callback information.