Inventory

API related to Device's Inventory.

get

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

/inventory/device-hw-skus

Get the distribution of Switch HW SKU's across the network

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-hw-skus

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/devices

Get inventory information of all the devices in the network

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/device-ip-transitions

Get the list of devices which had IP transitions including details.

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-ip-transitions

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/devices-lic-count

Get the count of licensed and non-licensed devices in the network.

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-lic-count

HTTPcURLJavaScriptPython

GET /api/inventory/devices-lic-count HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

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

/inventory/device-ports

Get all port information for a specific 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/device-ports

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/device-peripherals

Get all peripheral (FAN, PSU) information for a specific 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/device-peripherals

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/device-firmware

Get all firmware information for a specific device.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

filterstringOptional

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

Note: For "deviceAddress" field accepts Mac address.

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/inventory/device-firmware

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/interface-flaps

Get all interface flap information for the network.

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/interface-flaps

HTTPcURLJavaScriptPython

GET /api/inventory/interface-flaps?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-ports

Get list of all devices with their port information

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-ports

HTTPcURLJavaScriptPython

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

No content

get

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

/inventory/fabrics

Get Fabric Summary

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/fabrics

HTTPcURLJavaScriptPython

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

No content