Firmware Management Service

Returns a list of firmwares.

Get a list of firmwares.

GEThttps://localhost:16003/api/v1/firmwares

Query parameters

Response

200403404

List firmwares

Body

application/json

firmwaresarray of FirmwareDetails (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmwares', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "firmwares": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "deviceType": "text",
      "description": "text",
      "revision": "text",
      "uri": "https://example.com",
      "image": "text",
      "firmwareHash": "text",
      "owner": "text",
      "location": "https://example.com",
      "uploader": "text",
      "digest": "text",
      "latest": false,
      "notes": [
        {
          "createdBy": "text",
          "note": "text"
        }
      ]
    }
  ]
}

Returns a Firmware

Get a Firmware.

GEThttps://localhost:16003/api/v1/firmware/{id}

Path parameters

id*string (uuid)

Response

200403404

A Firmware definition

Body

application/json

idstring (uuid)

deviceTypestring

descriptionstring

revisionstring

uristring (uri)

imagestring

imageDateinteger (int64)

sizeinteger (int64)

downloadCountinteger (int64)

firmwareHashstring

ownerstring

locationstring (uri)

uploaderstring

digeststring

latestboolean

notesarray of NoteInfo (object)

createdinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

Create A New firmware

POSThttps://localhost:16003/api/v1/firmware/{id}

Path parameters

id*string (uuid)

Body

application/json

idstring (uuid)

deviceTypestring

descriptionstring

revisionstring

uristring (uri)

imagestring

imageDateinteger (int64)

sizeinteger (int64)

downloadCountinteger (int64)

firmwareHashstring

ownerstring

locationstring (uri)

uploaderstring

digeststring

latestboolean

notesarray of NoteInfo (object)

createdinteger (int64)

Response

200403404

Created a firmware entry.

Body

application/json

idstring (uuid)

deviceTypestring

descriptionstring

revisionstring

uristring (uri)

imagestring

imageDateinteger (int64)

sizeinteger (int64)

downloadCountinteger (int64)

firmwareHashstring

ownerstring

locationstring (uri)

uploaderstring

digeststring

latestboolean

notesarray of NoteInfo (object)

createdinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

Update A New firmware

PUThttps://localhost:16003/api/v1/firmware/{id}

Path parameters

id*string (uuid)

Body

application/json

Firmware details

idstring (uuid)

deviceTypestring

descriptionstring

revisionstring

uristring (uri)

imagestring

imageDateinteger (int64)

sizeinteger (int64)

downloadCountinteger (int64)

firmwareHashstring

ownerstring

locationstring (uri)

uploaderstring

digeststring

latestboolean

notesarray of NoteInfo (object)

createdinteger (int64)

Response

200403404

Successfully updated firmware

Body

application/json

idstring (uuid)

deviceTypestring

descriptionstring

revisionstring

uristring (uri)

imagestring

imageDateinteger (int64)

sizeinteger (int64)

downloadCountinteger (int64)

firmwareHashstring

ownerstring

locationstring (uri)

uploaderstring

digeststring

latestboolean

notesarray of NoteInfo (object)

createdinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deviceType": "text",
  "description": "text",
  "revision": "text",
  "uri": "https://example.com",
  "image": "text",
  "firmwareHash": "text",
  "owner": "text",
  "location": "https://example.com",
  "uploader": "text",
  "digest": "text",
  "latest": false,
  "notes": [
    {
      "createdBy": "text",
      "note": "text"
    }
  ]
}

Delete some Firmware

DELETEhttps://localhost:16003/api/v1/firmware/{id}

Path parameters

id*string (uuid)

Response

204403404

Successfully deleted Firmware for the device.

Body

application/json

Success (any)

The requested operation was performed.

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmware/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

403404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

List all the defined device revision history

GEThttps://localhost:16003/api/v1/revisionHistory/{serialNumber}

Path parameters

serialNumber*string

Query parameters

Response

200403404

List of device history upgrade.

Body

application/json

historyarray of RevisionHistoryEntry (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/revisionHistory/{serialNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "history": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "serialNumber": "text",
      "revisionId": "123e4567-e89b-12d3-a456-426614174000",
      "fromRelease": "text",
      "toRelease": "text",
      "commandUUID": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Delete specific hostory elements for a device

DELETEhttps://localhost:16003/api/v1/revisionHistory/{serialNumber}

Path parameters

serialNumber*string

Query parameters

Response

204403404

Success.

Body

application/json

Success (any)

The requested operation was performed.

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/revisionHistory/{serialNumber}?id=123e4567-e89b-12d3-a456-426614174000', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

403404

{
  "ErrorCode": 0,
  "ErrorDetails": "text",
  "ErrorDescription": "text"
}

Calculate how old a version of firmware is.

GEThttps://localhost:16003/api/v1/firmwareAge

Query parameters

Response

200403404

The recommended latest version to update to.

Body

application/json

one of

FirmwareAgeDetails (object)FirmwareAgeDetailsList (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/firmwareAge?revision=text&deviceType=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "latestId": "text",
  "image": "text",
  "revision": "text",
  "uri": "https://example.com",
  "age": "this is in seconds. a 0 means we cannot determine the age. something like 'unknown' should be shown to the user.",
  "latest": false
}

Get a list of connected devices and some values.

GEThttps://localhost:16003/api/v1/connectedDevices

Query parameters

Response

200403404

List firmwares

Body

application/json

devicesarray of DeviceConnectionInformation (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/connectedDevices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "devices": [
    {
      "serialNumber": "text",
      "revision": "text",
      "deviceType": "text",
      "endPoint": "https://example.com",
      "status": "connected"
    }
  ]
}

Get status of a connected device.

GEThttps://localhost:16003/api/v1/connectedDevice/{serialNumber}

Path parameters

serialNumber*string

SerialNumber of the device

Response

200403404

Get information about a connected device.

Body

application/json

serialNumberstring

revisionstring

deviceTypestring

endPointstring (uri)

lastUpdateinteger (uint64)

statusenum

connecteddisconnectedunknown

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/connectedDevice/{serialNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "serialNumber": "text",
  "revision": "text",
  "deviceType": "text",
  "endPoint": "https://example.com",
  "status": "connected"
}

get an analysis of the existing devices we know about.

GEThttps://localhost:16003/api/v1/deviceReport

Response

200403404

A full analysis report

Body

application/json

snapshotinteger (int64)

numberOfDevicesinteger (int64)

ouisTagIntPairList (object)

revisionsTagIntPairList (object)

deviceTypesTagIntPairList (object)

statusTagIntPairList (object)

endPointsTagIntPairList (object)

unknownFirmwaresTagIntPairList (object)

usingLatestTagIntPairList (object)

totalSecondsOldTagIntPairList (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/deviceReport', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "ouis": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "revisions": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "deviceTypes": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "status": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "endPoints": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "unknownFirmwares": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "usingLatest": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  },
  "totalSecondsOld": {
    "tagList": [
      {
        "tag": "text"
      }
    ]
  }
}

Retrieve different values from the running service.

GEThttps://localhost:16003/api/v1/system

Query parameters

Response

200403404

Successfull command execution

Body

application/json

one of

SystemInfoResults (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/system?command=info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403404

{
  "version": "text",
  "os": "text",
  "hostname": "text",
  "certificates": [
    {
      "filename": "text"
    }
  ]
}

Perform some system wide commands

POSThttps://localhost:16003/api/v1/system

Body

application/json

Command details

one of

SystemCommandSetLogLevel (object)SystemCommandReload (object)SystemCommandGetLogLevels (object)SystemCommandGetLogLevelNames (object)SystemCommandGetSubsystemNames (object)

Response

200403404

Successfull command execution

Body

application/json

one of

SystemGetLogLevelsResult (object)SystemCommandGetLogLevelNamesResult (object)SystemGetSubSystemNemesResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://localhost:16003/api/v1/system', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}