Firmware Management Service

Returns a list of firmwares.

get

Get a list of firmwares.

Authorizations
X-API-KEYstringRequired
Query parameters
offsetintegerOptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegerOptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringOptional

Filter the results

latestOnlybooleanOptional

Return only the latest firwares

deviceTypestringOptional
revisionSetbooleanOptional
deviceSetbooleanOptional
Responses
200

List firmwares

application/json
get
/firmwares

Returns a Firmware

get

Get a Firmware.

Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired
Responses
200

A Firmware definition

application/json
get
/firmware/{id}

Create A New firmware

post
Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired
Body

Definition of a firmware release

idstring · uuidOptional
deviceTypestringOptional
descriptionstringOptional
revisionstringOptional
uristring · uriOptional
imagestringOptional
imageDateinteger · int64Optional
sizeinteger · int64Optional
downloadCountinteger · int64Optional
firmwareHashstringOptional
ownerstringOptional
locationstring · uriOptional
uploaderstringOptional
digeststringOptional
latestbooleanOptional
createdinteger · int64Optional
Responses
200

Created a firmware entry.

application/json
post
/firmware/{id}

Update A New firmware

put
Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired
Body

Definition of a firmware release

idstring · uuidOptional
deviceTypestringOptional
descriptionstringOptional
revisionstringOptional
uristring · uriOptional
imagestringOptional
imageDateinteger · int64Optional
sizeinteger · int64Optional
downloadCountinteger · int64Optional
firmwareHashstringOptional
ownerstringOptional
locationstring · uriOptional
uploaderstringOptional
digeststringOptional
latestbooleanOptional
createdinteger · int64Optional
Responses
200

Successfully updated firmware

application/json
put
/firmware/{id}

Delete some Firmware

delete
Authorizations
X-API-KEYstringRequired
Path parameters
idstring · uuidRequired
Responses
delete
/firmware/{id}

No content

List all the defined device revision history

get
Authorizations
X-API-KEYstringRequired
Path parameters
serialNumberstringRequired
Query parameters
offsetintegerOptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegerOptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringOptional

Filter the results

Responses
200

List of device history upgrade.

application/json
get
/revisionHistory/{serialNumber}

Delete specific hostory elements for a device

delete
Authorizations
X-API-KEYstringRequired
Path parameters
serialNumberstringRequired
Query parameters
idstring · uuidRequired

Pagination start (starts at 1. If not specified, 1 is assumed)

Responses
delete
/revisionHistory/{serialNumber}

No content

Calculate how old a version of firmware is.

get
Authorizations
X-API-KEYstringRequired
Query parameters
revisionstringRequired

The exact current verion of the firmware on that device.

deviceTypestringRequired

The exact current verion of the firmware on that device.

selectstringOptional

Specify lits of serial numbers to retrive age for

Example: select=serial1,serial2,serial4,serial5.
Responses
200

The recommended latest version to update to.

application/json
Responseone of
or
get
/firmwareAge

Get a list of connected devices and some values.

get
Authorizations
X-API-KEYstringRequired
Query parameters
offsetintegerOptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegerOptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringOptional

Filter the results

Responses
200

List firmwares

application/json
get
/connectedDevices

Get status of a connected device.

get
Authorizations
X-API-KEYstringRequired
Path parameters
serialNumberstringRequired

SerialNumber of the device

Responses
200

Get information about a connected device.

application/json
get
/connectedDevice/{serialNumber}

get an analysis of the existing devices we know about.

get
Authorizations
X-API-KEYstringRequired
Responses
200

A full analysis report

application/json
get
/deviceReport

Retrieve different values from the running service.

get
Authorizations
X-API-KEYstringRequired
Query parameters
commandstring · enumRequired

Get a value

Possible values:
Responses
200

Successfull command execution

application/json
Responseone of
get
/system

Perform some system wide commands

post
Authorizations
X-API-KEYstringRequired
Body
anyOptional
or
or
or
or
Responses
200

Successfull command execution

application/json
Responseone of
or
or
post
/system

Last updated