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}/index/{lastSeenDeviceId} | 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} | Retrieve campaign level information for a specified campaign |
| PUT /campaigns/firmware/{acc}/{campaignId} | Add or remove devices from a campaign |
| PUT /campaigns/firmware/{acc}/{campaignId}/dates | Change the campaign dates and time windows |
| DELETE /campaigns/{acc}/{campaignId} | Cancel a campaign |
Reports
| HTTP Request | Description |
|---|---|
| GET /reports/{acc}campaigns/{campaignID}/devices | Get a list of all devices in a campaign and the status of each device |
| GET /reports/{acc}/devices/{deviceId} | Campaign history for a specific device |
| GET /reports/{acc}/campaigns?campaignStatus={status value} | Retrieve a list of campaigns for an account that have a specified campaign status |
Devices
| HTTP Request |
Description |
|---|---|
| GET /devices/{acc} | Get account device information such as reported firmware on the devices |
| POST /devices/{acc} | Get device information for a list of devices on an account |
Firmware
| HTTP Request | Description |
|---|---|
| GET /firmware/{acc} | Get a list of available firmware |
| PUT /firmware/{acc}/devices | Synchronize ThingSpace with the FOTA server for up to 100 devices |
| PUT /firmware/{acc}/async/{deviceId} | Ask a device to report its firmware version asynchronously |
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 |