Firmware Management Service

PreviousGateway Service NextProvisioning Service

Last updated 2 years ago

Was this helpful?

Returns a list of firmwares.

get

Get a list of firmwares.

Authorizations

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 firmware

Default: false

deviceTypestringoptional

revisionSetbooleanoptionalDefault: false

deviceSetbooleanoptional

rcOnlybooleanoptionalDefault: false

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/firmwares' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

List firmwares

Returns a Firmware

get

Get a Firmware.

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/firmware/{id}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

A Firmware definition

Delete some Firmware

delete

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16003/api/v1/firmware/{id}' \
  --header 'X-API-KEY: YOUR_API_KEY'

204

403

404

No body

Successfully deleted Firmware for the device.

List all the defined device revision history

get

Authorizations

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

currentListbooleanoptional

Return current device list and current firmware

Default: falseExample: You must set {serialNumber} to 000000000000

unknownListbooleanoptional

Return current device list and current firmware

Default: falseExample: You must set {serialNumber} to 000000000000

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/revisionHistory/{serialNumber}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

List of device history upgrade.

Delete specific hostory elements for a device

delete

Authorizations

Path parameters

serialNumberstringrequired

Query parameters

idstring · uuidrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://localhost:16003/api/v1/revisionHistory/{serialNumber}?id=123e4567-e89b-12d3-a456-426614174000' \
  --header 'X-API-KEY: YOUR_API_KEY'

204

403

404

No body

Success.

Calculate how old a version of firmware is.

get

Authorizations

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/firmwareAge?revision=text&deviceType=text' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

{
  "latestId": "text",
  "image": "text",
  "imageDate": 1,
  "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": true
}

The recommended latest version to update to.

Get a list of connected devices and some values.

get

Authorizations

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/connectedDevices' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

List firmwares

Get status of a connected device.

get

Authorizations

Path parameters

serialNumberstringrequired

SerialNumber of the device

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/connectedDevice/{serialNumber}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

Get information about a connected device.

get an analysis of the existing devices we know about.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/deviceReport' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

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

A full analysis report

receive a repor on a single decide

get

Authorizations

Path parameters

serialNumberstringrequiredExample: aabbccdd1234

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/deviceInformation/{serialNumber}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

No body

Retrieve different values from the running service.

get

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://localhost:16003/api/v1/system?command=info' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

403

404

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Successfull command execution

Create A New firmware

post

Authorizations

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

notesobject[]optional

createdinteger · int64optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16003/api/v1/firmware/{id}' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "deviceType": "text",
    "description": "text",
    "revision": "text",
    "uri": "https://example.com",
    "image": "text",
    "imageDate": 1,
    "size": 1,
    "downloadCount": 1,
    "firmwareHash": "text",
    "owner": "text",
    "location": "https://example.com",
    "uploader": "text",
    "digest": "text",
    "latest": true,
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1
  }'

200

403

404

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

Created a firmware entry.

Update A New firmware

put

Authorizations

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

notesobject[]optional

createdinteger · int64optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://localhost:16003/api/v1/firmware/{id}' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "deviceType": "text",
    "description": "text",
    "revision": "text",
    "uri": "https://example.com",
    "image": "text",
    "imageDate": 1,
    "size": 1,
    "downloadCount": 1,
    "firmwareHash": "text",
    "owner": "text",
    "location": "https://example.com",
    "uploader": "text",
    "digest": "text",
    "latest": true,
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1
  }'

200

403

404

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

Successfully updated firmware

Perform some system wide commands

post

Authorizations

Body

one ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://localhost:16003/api/v1/system' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "setloglevel",
    "subsystems": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

403

404

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

Successfull command execution

Returns a list of firmwares.

Returns a Firmware

Delete some Firmware

List all the defined device revision history

Delete specific hostory elements for a device

Calculate how old a version of firmware is.

Get a list of connected devices and some values.

Get status of a connected device.

get an analysis of the existing devices we know about.

receive a repor on a single decide

Retrieve different values from the running service.

Create A New firmware

Show child attributes

Update A New firmware

Show child attributes

Perform some system wide commands

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes