API Reference

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 or /v2 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
POST /licenses/{account}/assign Assign licenses to devices
POST /licenses/{account}/remove Remove licenses from devices
POST /licenses/{account}/cancel Create a cancellation candidate list
GET /licenses/{account}/cancel Get the list of cancellation candidate devices
DELETE /licenses/{account}/cancel Delete the list of cancellation candidate devices

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