REST API Utilities Routes Firmware info

April 13, 2023 at 2:39 AM

Firmware info

Role

Read the firmware stored in a file.

Prototype

URL : /utilities/firmware-info

Method : POST

URL Params : None

Request data :

Field name Type Status Description
File string required The firmware file name or URL.
Local files: start the string with “file://”
Remote files: start the string with either “http://” or “https://”
Other schemes (FTP etc) are not supported.

Success Response

Code : 200 OK

Content : a FIRMWARE-INFO object, as specified below.

FIRMWARE-INFO object definition

This object matches the FIRMWARE-INFO object returned by the Device / Firmware info route.

Field name Type Status Description
Vendor string always Vendor name
Product string always Product name
Firmware string always Identification of the firmware
Version string always Product version, format M.mm
Revision string always Complete version, format M.mm-bbb-gcccccccc
BuildDate string always Compilation date, format yyyy-mm-dd

Example

{
	"Vendor": "SpringCard",
	"Product": "Puck",
	"Firmware": "SpringCore/H518/Puck",
	"Version": "0.80",
	"Revision": "0.80-138-g56e5ed58",
	"BuildDate": "2019-05-16"	
}

Error Response

See Error Responses.