Synchronize Device Firmware

`PUT /firmware/{acc}/devices`

This endpoint allows a user to get the reported firmware from the device management server for a particular device.

Request Components

HTTP Request

`PUT https://thingspace.verizon.com/api/fota/v3/firmware/{acc}/devices`

Resource Path and Query Parameters

Parameter Name	Data Type	Description
acc required	string	Account identifier.

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
Content-Type required	string	Must be `application/json`.

Request Body

Parameter Name	Data Type	Description
deviceList required	array	A list of IMEIs for devices to be synchronized between ThingSpace and the FOTA server

Example Request

The request body identifies the devices to be synchronized with FOTA server

curl --l --r PUT 'https://thingspace.verizon.com/api/fota/v3/firmware/0642233522-00001/devices' \
-H 'VZ-M2M-Token: {M2M token}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer token}' \
--data-raw '{
   "deviceList": [
       "15-digit IMEI",
       "15-digit IMEI"
   ]
}'

Success Responses

Status 200

Parameter Name	Data Type	Description
accountName	string	The account identifier.
deviceFirmwarVersionList	array	An array of the firmware information
deviceId	string	The device identifier (IMEI)
status	string	Firmware sync status
reason	string	Additional information about the status if applicable
firmwareVersion	string	The numeric or alpha-numeric identifier of the firmware and its version
VersionUpdateTime	string($date-time)	The timestamp of the most recent upgrade

Example Success Response

An object showing the Account ID, the Device ID and the Firmware that the device has been updated to.

{
   "accountName": "0000123456-00001",
   "deviceFirmwarVersionList": [
       {
           "deviceId": "15-digit IMEI",
           "status": "FirmwareVersionUpdateSuccess",
           "Reason": "",
           "firmwareVersion": "SR1.2.0.0-10657",
           "VersionUpdateTime": "2022-02-04 06:10:01.441 +0000 UTC"
       }
   ]
}

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.