Inventory

API related to Device's Inventory.

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/FMAgentVersionList

Returns FM (Fabric Manager) agent version distribution across devices with count and percentage.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/FMAgentVersionList

HTTPcURLJavaScriptPython

GET /api/inventory/FMAgentVersionList HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Roles

Count of devices in different roles i.e Leaf/Spine etc.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Roles

HTTPcURLJavaScriptPython

GET /api/inventory/Roles HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/SwitchSKUs

Get a count & percentage distribution of Switch SKU's across fabric.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/SwitchSKUs

HTTPcURLJavaScriptPython

GET /api/inventory/SwitchSKUs HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices

Get list of devices based on specific filters (SKU, Vendor, ASIC)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices

HTTPcURLJavaScriptPython

GET /api/inventory/Devices HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/ActionBtn

Get list of devices based on specific filters (SKU, Vendor, ASIC)

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/ActionBtn

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/ActionBtn HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/DeviceIpTrans

Returns device IP transition history showing old and new IP addresses, conflicts, and timestamps.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/DeviceIpTrans

HTTPcURLJavaScriptPython

GET /api/inventory/DeviceIpTrans HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/streaming-status-history

Returns historical streaming status data for a device showing status transitions over time.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "68:21:5F:A6:61:72",
 "windowSize" : "1 hour"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/streaming-status-history

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/streaming-status-history?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/streaming-status

Returns time series data for device streaming status over a specified time window.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "68:21:5F:A6:61:72",
 "windowSize" : "1 hour"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/streaming-status

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/streaming-status?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/qosOnly

Returns list of devices that support QoS (Quality of Service) functionality.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/qosOnly

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/qosOnly HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/count

Returns count of licensed and non-licensed devices in the inventory.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/count

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/count HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/interfaces

Provides Interface information e.g. name, alias, transcievers specific details, etc. of a device

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/interfaces

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/interfaces HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/peripherals

Provides device's Fan and PSU hardware information.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

422

Unprocessable Entity

500

Internal Server Error

get

/inventory/Devices/peripherals

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/peripherals HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/deviceInfo

Returns detailed device information including hardware specs, firmware details, and system information for a specific device.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

ipAddressstringRequired

10.4.4.23

Note: IP address of the device.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/deviceInfo

HTTPcURLJavaScriptPython

GET /api/inventory/deviceInfo?ipAddress=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/Devices/firmware

Returns firmware information for a specific device including BIOS, bootloader, and other firmware components.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "deviceAddress" : "68:21:5F:A6:61:72"
}

Note: For "deviceAddress" field accepts IP or Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/Devices/firmware

HTTPcURLJavaScriptPython

GET /api/inventory/Devices/firmware?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/linkInfo

Returns detailed information about a specific link including utilization, status, and device details.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

linkIdstringRequired

Link ID in format: linkId_hostId (e.g., 123_0)

macaddressstringRequired

MAC address of the device (e.g., 68:21:5F:A6:61:72)

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

404

Link information not available

500

Internal Server Error

get

/inventory/linkInfo

HTTPcURLJavaScriptPython

GET /api/inventory/linkInfo?linkId=text&macaddress=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/minizip-test

Exports inventory data as a password-protected ZIP file containing device information in CSV format.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

ZIP file download

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/minizip-test

HTTPcURLJavaScriptPython

GET /api/inventory/minizip-test HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/interfaceFlaps

Returns interface flap data showing interfaces that have changed status (up/down) within a specified time frame.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringRequired

{
 "startTime" : "2026-01-23 02:09:36",
 "endTime" : "2026-01-23 03:09:36",
 "limit" : 10
}

Note: startTime and endTime are in UTC format. limit is the number of records to return.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/interfaceFlaps

HTTPcURLJavaScriptPython

GET /api/inventory/interfaceFlaps?filter=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/interfaceMega

Returns aggregated interface information including link status, cabling distribution, and flapped interfaces.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/interfaceMega

HTTPcURLJavaScriptPython

GET /api/inventory/interfaceMega HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/nic-info

Returns NIC (Network Interface Card) information for a specific device including network interface details.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

macstringOptional

MAC address of the device (e.g., 68:21:5F:A6:61:72). Either mac or ip is required.

ipstringOptional

IP address of the device (e.g., 10.4.5.117). Either mac or ip is required.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/nic-info

HTTPcURLJavaScriptPython

GET /api/inventory/nic-info HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/device-details

Returns comprehensive information for a single device including hardware, software, and configuration details.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

macstringOptional

MAC address of the device (e.g., 68:21:5F:A6:61:72). Either mac or ip is required.

ipstringOptional

IP address of the device (e.g., 10.4.5.117). Either mac or ip is required.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/device-details

HTTPcURLJavaScriptPython

GET /api/inventory/device-details HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/inv-details-orchest

Returns inventory details specifically formatted for orchestrator services including device and interface information.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

instancestringRequired

Database instance identifier or fm for first host

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/inv-details-orchest

HTTPcURLJavaScriptPython

GET /api/inventory/inv-details-orchest?instance=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/inventory/deviceDownInfo

Returns information about devices that went down within a specified time period.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/inventory/deviceDownInfo

HTTPcURLJavaScriptPython

POST /api/inventory/deviceDownInfo HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "type": "object",
  "properties": {
    "startTime": {
      "type": "string",
      "format": "date-time"
    },
    "endTime": {
      "type": "string",
      "format": "date-time"
    },
    "limit": {
      "type": "integer"
    }
  }
}

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/inventory/dockerInfo

Fetch docker container information aggregated for a given time period (in minutes).

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

requiredstring[]OptionalExample: ["timePeriod"]

Responses

200

List of docker info grouped by device and container

application/json

typestringOptionalExample: array

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/inventory/dockerInfo

HTTPcURLJavaScriptPython

POST /api/inventory/dockerInfo HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "type": "object",
  "properties": {
    "timePeriod": {
      "type": "integer",
      "description": "Time period in minutes (e.g. 60 = last 1 hour)",
      "examples": null
    }
  },
  "required": [
    "timePeriod"
  ]
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "device_mac_address": {
        "type": "string",
        "examples": null
      },
      "name": {
        "type": "string",
        "examples": null
      },
      "switchip": {
        "type": "string",
        "examples": null
      },
      "hostname": {
        "type": "string",
        "examples": null
      },
      "count": {
        "type": "integer",
        "examples": null
      }
    }
  }
}

post

https://localhost:3000/apihttp://localhost:3000/api

/inventory/creds

Adds device credentials (username/password) for a specific device IP address.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/inventory/creds

HTTPcURLJavaScriptPython

POST /api/inventory/creds HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "type": "object",
  "properties": {
    "deviceAddress": {
      "type": "string",
      "description": "Device IP address"
    },
    "creds": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    }
  }
}

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/device-yaml-files

Returns YAML configuration files for devices from the assets directory.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/device-yaml-files

HTTPcURLJavaScriptPython

GET /api/inventory/device-yaml-files HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/inventory/mini-inventory

Returns a concise inventory of devices including essential details like hostname, IP, MAC address, layer, region, and hardware SKU.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/mini-inventory

HTTPcURLJavaScriptPython

GET /api/inventory/mini-inventory HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content