Get Upgrade Information

Get Information about an Upgrade:
GET /upgrades/{account}/upgrade/{upgradeId}

Returns information about a specified upgrade, include the target date of the upgrade, the list of devices in the upgrade, and the status of the upgrade for each device.

Contents

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

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/fota/v1/upgrades/{account}/upgrade/{upgradeId}

Resource Path and Query Parameters

You must include the account name in the path and the ID of the upgrade.

Parameter Name Data Type Description
account
required
string The name of the account that has the scheduled upgrade. An account name is usually numeric, and must include any leading zeros.
upgradeId
required
UUID string The UUID of the upgrade, returned by POST /upgrades when the upgrade was scheduled.

Header Parameters

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

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

Request Body

None.

Example Request

Request the details of a scheduled upgrade for an account:

curl https://thingspace.verizon.com/api/fota/v1/upgrades/$ACCOUNT/upgrade/$UPGRADE_ID  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A success response contains these upgrade details:

Parameter Name Data Type Description
id string Unique upgrade identifier.
accountName string The name (number) of the billing account.
firmwareName string The name of the firmware image that will be used for the upgrade.
firmwareTo string The name of the firmware version that will be on the devices after a successful upgrade.
startDate string The intended start date for the upgrade.
status string The current status of the upgrade, either scheduled or unscheduled.
deviceList
array of objects A JSON object for each device that was included in the upgrade, showing the device IMEI, the status of the upgrade, and additional information about the status.
deviceId
string The device IMEI.
status
string The status of the upgrade for this device, which may be different from the overall upgrade status.
resultReason
string More information about the device’s upgrade status.

Example Success Response

{  
  "id":"60b5d639-ccdc-4db8-8824-069bd94c95bf",
  "accountName":"0402196254-00001",
  "firmwareName":"FOTA_Verizon_Model-A_01To02_HF",
  "firmwareTo": "VerizonFirmwareVersion-02",
  "startDate":"2018-04-01",
  "status":"Queued",
  "deviceList": [
    {
      "deviceId": "900000000000002",
      "status": "Device Accepted",
      "resultReason": "success"
    },
    {
      "deviceId": "900000000000003",
      "status": "Device Accepted",
      "resultReason": "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.