Upgradefirmware - MSA Grid RESTful API Startup Manual

2.6.2

UpgradeFirmware

Description: Initiates a firmware upgrade for a given deviceID and version
HTTP Verb: POST
URL:
/rest/method/fieldpop-api/upgradeFirmware
Query String Parameters:
•
happn_token - Token obtained from the login request.
Body Parameters (JSON):
•
parameters - object containing the following fields:
o
deviceID - the IIoT gateway ID (see Section 3.1.1)
o
firmwareVersion - the semantic versioning (or semver) of firmware to load on the IIoT
Gateway
Example 3 – POST URL:
/rest/method/fieldpop-api/upgradeFirmware?happn_token=eyJ0eXAiOiJKV1QiLC
Example 3 – JSON Payload:
{
"parameters": {
"deviceID": "cybersparrow_NkWMIrKbyQ",
"firmwareVersion": "5.4.2"
}
}
Example 3 – JSON Response:
{
"message": "Call successful",
"data": null,
"error": null
}
Grid RESTful API Start-up Guide
Install OpenVPN Client
42