Get a Device’s Firmware Upgrade History:

GET /reports/{account}/devices/{deviceId}

Returns the upgrade history of the specified device from the previous six months.


See also:
View Upgrades by Status
Schedule Firmware Upgrade
Cancel an Upgrade

Request Components

HTTP Request


Resource Path and Query Parameters

You must include the account name and the device IMEI in the path.

Parameter Name Data Type Description
string The name of the account. An account name is usually numeric, and must include any leading zeros.
IMEI string The IMEI of the device for which you want the upgrade history.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token.

Parameter Name Data Type Description
string HTTP Authorization request header containing a valid Bearer token.
string A valid session token returned by a Connectivity Management POST /session/login request.

Request Body


Example Request

Request the upgrade history of a device:

curl  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A success response contains an array of firmware upgrades that the device has had, and each upgrade object has these details:

Parameter Name Data Type Description
deviceId string The IMEI of the device.
id UUID string The unique identifier for the upgrade.
accountName string The name (number) of the billing account.
firmwareFrom string The firmware version that was on the device before the upgrade.
firmwareTo string The name of the firmware version that was on the device after the upgrade.
startDate string The date of the upgrade.
upgradeStartTime string The date and time that the upgrade actually started for this device.
status string

The status of the upgrade for this device, which may be different from the overall upgrade status.

If, within one day of the start date, the campaign fails this status will show failure. 

However, ThingSpace queues OMA-DM upgrades in the network indefinitely so the upgrade may actually be successful. Use the Device List API to check the latest reported firmware on the device.

reason string More information about the status.

Example Success Response

        "deviceId": "900000000000001",
        "id": "f574fbb8-b291-4cc7-bf22-4e3f27977558",
        "accountName": "0242078689-00001",
        "firmwareFrom": "VerizonFirmwareVersion-02",
        "firmwareTo": "VerizonFirmwareVersion-03",
        "startDate": "2018-03-05",
        "upgradeStartTime": "2018-03-05T19:07:21Z",
        "status": "UpgradeSuccess",
        "reason": "success"
        "deviceId": "900000000000001",
        "id": "5edade25-c06c-4b13-ba2a-fbb9ada93579",
        "accountName": "0242078689-00001",
        "firmwareFrom": "VerizonFirmwareVersion-01",
        "firmwareTo": "VerizonFirmwareVersion-02",
        "startDate": "2018-02-20",
        "upgradeStartTime": "2018-02-20T00:03:19Z",
        "status": "UpgradeSuccess",
        "reason": "success"

Failure Responses

Status 400

All error messages are returned in this format:

  "errorCode": "error code string",
  "errorMessage": "error message string"

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.