API Reference v2

API Reference v2

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 or /v2 resource path.

Subscriptions and Licenses

HTTP Request Description
GET /subscriptions/{acc} Retrieve the status of an account’s Software Management Services subscription
GET /licenses/{acc} Retrieve license status, including total number of licenses, number of assigned licenses, and a device list
POST /licenses/{acc}/assign Assign licenses to devices
POST /licenses/{acc/remove Remove licenses from devices

Campaigns

HTTP Request Description
POST /campaigns/{acc} Schedule a software upgrade for a list of devices
GET /campaigns/{acc}/{campaignId} Get information on a software upgrade.
DELETE /campaigns/{acc}/{campaignId} Cancel a scheduled upgrade
PUT /campaigns/{acc}/{campaignId} Add or remove a device to an existing software upgrade.
PUT /campaigns/{acc}/{campaignId}/dates Change campaign dates and time windows.

Reports

HTTP Request Description
GET /software/{acc} Get a list of available software
GET /devices/{acc} Get a list of devices in an account
GET /reports/{acc}/devices/{deviceId} Get device software upgrade history.
GET /reports/{acc}/campaigns Get campaign history by status
GET /reports/{acc}campaigns/{campaignID}/devices Get campaign device status

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.

Client Logging

HTTP Request Description
GET /logging/{acc}/devices Get a list of devices with logging enabled.
PUT /logging/{acc}/devices Enable logging for a list of devices.
DELETE /logging/{acc}/devices Disable logging for a list of devices.
PUT /logging/{acc}/devices/{deviceId} Enable logging for a specific device.
DELETE /logging/{acc}/devices/{deviceId} Disable logging for a specific device.
GET /logging/{acc}/devices/{deviceId}/logs Get logs for a specific device.

Server Logging

HTTP Request Description
GET /logging/{acc}/devices/{deviceId}/checkInHistory Get check-in history for a specific device.