- Overview
- What's new
-
Getting Started
- Campaign Timing
- Pilot Campaigns
- Verbose Logging
- Configuration Files for HTTP FOTA
- Campaign Lifecycle Flow for v1
- Campaign Lifecycle Flow for v2
- Campaign Lifecycle Flow for v3
- Software Management Services Subscriptions
- Get Credentials
- About Callback Services
- Create A Simple Callback Receiver
- API Console
-
API Reference v1
- Get Subscription Status
- Get License Status
- Get Device List
- Get Firmware List
- Schedule Firmware Upgrade
- Add or Remove Devices in a Scheduled Upgrade
- Get Upgrade Information
- Modify Scheduled Upgrade
- Cancel An Upgrade
- Get Device Upgrade History
- Get Upgrades By Status
- Register Callback Listener
- Get Callback Listeners
- Deregister Callback Listener
- Error Messages
-
API Reference v2
- Get FOTA Subscription
- Get an Account's License Status
- Schedule an Upgrade
- Upload a New File
- Get Upgrade Information
- Cancel an Upgrade
- Add or Remove Devices in an Upgrade
- Change Campaign Dates and Time Windows
- 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
- Register a Callback Listener URL
- Modify a Callback Listener URL
- Get Registered Callback Listeners
- Deregister a Callback Listener
- Get a List of Devices with Logging Enabled
- Enabled Logging for a List of Devices
- Disable Logging for a List of 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
- Get FOTA Subscription
- Get an Account's License Status
- Assign Licenses to Devices
- Remove FOTA Licenses
- Schedule a Firmware Upgrade
- Get Upgrade Information
- Cancel an Upgrade
- Get Device Status in a Campaign
- Get a Device's Software Upgrade History
- Get a List of Available Firmware
- Synchronize Device Firmware
- Get a List of Devices in an Account
- Register a Callback Listener URL
- Modify a Callback Listener URL
- Get Registered Callback Listeners
- Deregister a Callback Listener
API Reference v1
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/{account} | Retrieve the status of an account’s Software Management Services subscription. |
| GET /licenses/{account} | Retrieve license status, including total number of licenses, number of assigned licenses, and a device list |
Firmware Upgrades
| HTTP Request | Description |
|---|---|
| GET /firmware/{account} | Get a list of available firmware for your devices |
| POST /upgrades | Schedule a firmware upgrade for a list of devices |
| GET /reports/{account}/status/{status} | View a list of upgrades with a specified status |
| GET /upgrades/{account}/upgrade/{upgradeId} | Get information about a specific upgrade |
| PUT /upgrades/{account}/upgrade/{upgradeId} | Add or remove devices from an upgrade |
| DELETE /upgrades/{account}/upgrade/{upgradeId} | Cancel a scheduled upgrade |
Reports
| HTTP Request | Description |
|---|---|
| GET /devices/{account} | Get a list of all devices in an account |
| GET /reports/{account}/device/{deviceId} | Get a device’s firmware upgrade history |
| GET /reports/{account}/status/{status} | View a list of upgrades with a specified status |
Callbacks
| HTTP Request | Description |
|---|---|
| POST /callbacks/{account} | Register a callback listener |
| GET /callbacks/{account} | Get a list of registered callback listeners |
| DELETE /callbacks/{account}/name/{service} | Stop receiving callbacks |