Premium APIsSoftware ManagementSoftware Management V3API Reference Pages V3
Synchronize Device Firmware
PUT /firmware/{accountName}/devices
This endpoint allows a user to get the reported firmware from the device management server for a particular device.
HTTP Request
PUT https://thingspace.verizon.com/api/fota/v3/firmware/{accountName}/devices
Header Parameters
The request header must contain a current ThingSpace authorization token, set the content to "JSON" and a current VZ-M2M-session token.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: 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 Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | Account identifier. This is numeric and in the format of 0000123456-00001. Leading zeros must be included. |
Request Body
| Parameter Name | Data Type | Description |
|---|---|---|
| deviceList (required) | array | A list of IMEIs for the devices to be synchronized between ThingSpace and the FOTA server. |
| Example Request: | ||
| The request body identifies the devices to be synchronized with the FOTA server: |
{
"deviceList": [
"15-digit IMEI",
"15-digit IMEI"
]
}Success Response
Status 200 A successful response is 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"
}
]
}Success Parameters
| 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. |
Failure Responses
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.