v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Firmware Management

Get device list with firmware details

This API endpoint retrieves list of device's firmware details such as firmware version, upgrade status, recommended version, firmware classification and last upgraded timestamp.

get/network-services/v1/firmware-details

Query parameters

filterstring const

OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.

Field	Operators
siteId	eq and in
siteName	eq and in
serialNumber	eq and in
deviceName	eq and in
deviceType	eq and in
upgradeStatus	eq and in
firmwareClassification	eq and in
firmwareVersion	eq and in

The operators are implemented as follows:

eq: Only values exactly matching the given value are returned.
in: Only values present in the given list are returned.

sortstring const

Example:deviceType,upgradeStatus desc

Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc(ascending) or desc (descending). The first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending. Supported fields are siteId, serialNumber, deviceName, deviceType, upgradeStatus, firmwareClassification, and firmwareVersion.

limitinteger

Specifies the number of results to be returned.

Example:20

Denotes the maximum number of items returned in the response. Maximum value is 1000.

nextstring

Specifies the pagination cursor for the next page of resources.

Example:1

Specifies the pagination cursor for the next page of resources. The minimum value is 1.

Response

List of device's firmware details, including Access Points, Switches, Gateways and associated pagination information.

countinteger required

Number of items in the response.

totalinteger

Specifies the total number of items available for a given filter query.

nextstring int32 required

Indicate the next page number, null if there are no further pages.

Example response

{
  "items": [
    {
      "serialNumber": "AP00000001",
      "deviceType": "ACCESS_POINT",
      "deviceName": "AP00000001",
      "siteId": "1120972196",
      "siteName": "Site1",
      "id": "AP00000001",
      "type": "network-services/firmware-management",
      "recommendedVersion": "8.6.0.6_77023",
      "upgradeStatus": "Up To Date",
      "firmwareClassification": "",
      "lastUpgradedTimeAt": "2024-04-30T06:52:18.712Z",
      "firmwareVersion": "8.5.2.0_59123"
    }
  ],
  "count": 1,
  "total": 4,
  "next": "2"
}