Firmware Paths

Get Firmware Paths

GET

https://api.securithings.com

/v1/firmwarePaths

Returns all firmware upgrade paths known to the platform.

Results can be filtered using the query parameters specified below.

Returns 200 with empty firmwarePaths list and a total of 0 when no paths found.

Get Firmware Paths › query Parameters

limit

integer · min: 1 · max: 1000

The number of items to return, default is 100 and maximum is 1000.

Default: 100

offset

integer · min: 0

The number of items to skip before starting to collect the result set.

Default: 0

vendor

string

Filter by device vendor.

model

string

Filter by device model.

managementPlatformType

string

Filter by the management platform type.

managementPlatformVersion

string

Filter by the management platform version.

sourceFirmware

string

Filter by the current firmware version.

targetFirmware

string

Filter by the target firmware version.

suggestedFirmware

string

Filter by the management platform's latest officially supported firmware version for the vendor/model.

status

string · enum

Filter by approval status.

Enum values:

pending

inProgress

approved

declined

deleted

source

string

Filter by the vendor firmware source.

createdAfter

string · date-time

Filter paths created after the specified date, in ISO 8601 format.

createdBefore

string · date-time

Filter paths created before the specified date, in ISO 8601 format.

Get Firmware Paths › Responses

A list of firmware upgrade paths.

FirmwarePath[]

A list of firmware upgrade paths.

total

integer

The total number of firmware upgrade paths matching the query.

GET/v1/firmwarePaths

curl https://api.securithings.com/v1/firmwarePaths \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "firmwarePaths": [
    {
      "id": "1a320af6-6cef-0b3f-de05-d5afd94261d4",
      "status": "approved",
      "vendor": "AXIS",
      "model": "C1210-E",
      "managementPlatformType": "genetec",
      "managementPlatformVersion": "5.13.1.2",
      "sourceFirmware": {
        "version": "10.10.70.1",
        "isBinaryAvailable": true
      },
      "targetFirmware": {
        "version": "11.11.192",
        "isBinaryAvailable": true
      },
      "suggestedFirmware": null,
      "source": [
        "upgradeMatrix",
        "manual"
      ],
      "createDate": "2026-04-06T13:19:10.000Z"
    }
  ],
  "total": 127
}

json

application/json

Tasks

Get Firmware Paths

GET

https://api.securithings.com

/v1/firmwarePaths

Returns all firmware upgrade paths known to the platform.

Results can be filtered using the query parameters specified below.

Returns 200 with empty firmwarePaths list and a total of 0 when no paths found.

Get Firmware Paths › query Parameters

limit

integer · min: 1 · max: 1000

The number of items to return, default is 100 and maximum is 1000.

Default: 100

offset

integer · min: 0

The number of items to skip before starting to collect the result set.

Default: 0

vendor

string

Filter by device vendor.

model

string

Filter by device model.

managementPlatformType

string

Filter by the management platform type.

managementPlatformVersion

string

Filter by the management platform version.

sourceFirmware

string

Filter by the current firmware version.

targetFirmware

string

Filter by the target firmware version.

suggestedFirmware

string

Filter by the management platform's latest officially supported firmware version for the vendor/model.

status

string · enum

Filter by approval status.

Enum values:

pending

inProgress

approved

declined

deleted

source

string

Filter by the vendor firmware source.

createdAfter

string · date-time

Filter paths created after the specified date, in ISO 8601 format.

createdBefore

string · date-time

Filter paths created before the specified date, in ISO 8601 format.

Get Firmware Paths › Responses

A list of firmware upgrade paths.

FirmwarePath[]

A list of firmware upgrade paths.

total

integer

The total number of firmware upgrade paths matching the query.