ThingSpace Software Management Services API

NOTE: There are new documentation pages that contains updated dynamic code generation & SDK downloads. You can access the new documents here.

The ThingSpace Software Management Services API lets customers manage, schedule, and distribute software updates to eligible 4G and 5G Internet of Things (IoT) devices already deployed in the field. This allows devices–even those in inaccessible locations–to be upgraded easily, reducing the need for site visits and truck rolls.

You can view device firmware versions and manage campaigns from ThingSpace Manage as well as through the Software Management Services API.

Table of Contents

What’s new in the Software Management Services API

Getting Started
Introduction to the Software Management Services API
About Campaigns
About Software Management Services Subscriptions and Licenses
Get credentials to use the API
About Callback Services
Create a simple callback receiver

API Console
Try the Software Management Services API

API Reference (v1)

Subscriptions and Licenses
Get account subscription status
Get license status
Assign licenses to devices
Remove licenses from devices
Create a list of licenses to remove
Get the list of licenses to remove
Delete the list of licenses to remove

Firmware Upgrades
Get a list of available firmware
Get a list of devices in an account
Schedule a firmware upgrade
Get information about an upgrade
View upgrades by status
Add or remove devices from an upgrade
Cancel a scheduled upgrade
Get a device’s firmware upgrade history

Callback Notifications
Register a callback listener
Get registered callback listeners
Stop receiving callbacks

API Reference (v2)

Subscriptions and Licenses
Get FOTA subscription
Get an account's license status
Assign FOTA licenses to HTTP devices
Remove FOTA licenses

License Cancellation Candidate Device List
Create a list of license cancellation candidate devices
Delete a previously created cancellation candidate device list
Retrieve a list of license cancellation candidate devices

Campaigns
Schedule a File Upgrade
Schedule an upgrade
Get upgrade information
Cancel an upgrade
Add or remove devices in an upgrade
Change campaign dates and time windows

Configuration or Supplementary Files
Upload a New File
Get a List of Available Files

Reports
Get a list of available software
Get a list of all devices in an account
Get a device's software upgrade history
Get campaign history
Get device status in a campaign

Callbacks
Register a callback listener URL
Modify a callback listener URL
Get registered callback listeners
Deregister a callback listener

Verbose Logging

Get a list of devices with logging enabled
Enable logging for devices
Disable logging for devices
Enable logging for a specific device
Disable logging for a specific device
Get logs for a specific device
Get check-in history for a specific device

API Reference (v3)

Subscriptions and Licenses
Get FOTA subscription
Get an account's license status
Assign FOTA licenses to devices
Remove FOTA licenses

Campaigns

Schedule a Firmware upgrade
Get upgrade information
Cancel an upgrade

Reports
Get device status in a campaign

Devices
Get the information for the devices on the account

Firmware
Get device Firmware information
Update device Firmware

Callbacks
Register a callback listener URL
Modify a callback listener URL
Get registered callback listeners
Deregister a callback listener