Inventory

The Inventory API provide install base information for all the devices that are a part of a customer’s inventory.

Features

The Inventory API provides the following features:

• Supports RESTful interface, using a RAML definition file.
• Supports JSON data format
• Includes web services that return:
  • List of network-elements with specific details
  • Hardware inventory details for a specific device
  • Inventories associated with specific customer
  • Software installed on a device

Hardware

Hardware API retrieves hardware inventory details for a specific device. This API can be used to return hardware details for a specific customer. All request parameters are optional other than “customerId”.

If "neInstanceId" is not provided as part of the request, the response contains hardware information for all devices in the inventory of the specified customer.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/inventory/hardware

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/inventory/hardware?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "neInstanceId": 55324697,
        "managedNeInstanceId": 52955578,
        "inventoryName": "Netformx_Default",
        "hwInstanceId": 55371628,
        "hwName": "GigabitEthernet2/0/19",
        "hwType": "Module",
        "productSubtype": null,
        "slot": null,
        "productFamily": "Transceiver Modules",
        "productId": "GLC-SX-MM",
        "productType": "Modules",
        "swVersion": "12.2(40)EX3",
        "serialNumber": "AGM121412R7",
        "serialNumberStatus": "Recognized",
        "hwRevision": null,
        "tan": null,
        "tanRevision": null,
        "pcbNumber": null,
        "installedMemory": 0,
        "installedFlash": 0,
        "collectedSerialNumber": "AGM121412R7",
        "collectedProductId": null,
        "productName": "GLC-SX-MM",
        "dimensionsFormat": null,
        "dimensions": null,
        "weight": null,
        "formFactor": null,
        "supportPage": null,
        "visioStencilUrl": null,
        "smallImageUrl": null,
        "largeImageUrl": null,
        "baseProductId": null,
        "productReleaseDate": null,
        "productDescription": "Nexus 9500 linecard"
    }
  ]
}

Network Elements

The Network Element API retrieves a list of devices along with specific details about those devices. All request parameters are optional other than “customerId”.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET: https://apix.cisco.com/cs/api/v1/inventory/network-elements

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/inventory/network-elements?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "collectorId": "CSP0009024971",
        "neInstanceId": 52824499,
        "managedNeInstanceId": 23493608,
        "inventoryName": "24OCT2017",
        "managementAddress": "172.21.34.65",
        "neSubtype": null,
        "inventoryAvailability": "Not Available",
        "lastConfigRegister": null
        "ipAddress": "10.59.226.19",
        "hostname": "SEML-HF317-AP001",
        "sysName": "SEML-KC044-WLC003",
        "featureSet": null,
        "inventoryCollectionDate": "2017-12-04",
        "productFamily": null,
        "productId": null,
        "productType": null,
        "createDate": "2017-12-13",
        "swType": "IOS",
        "swVersion": "15.2(4)JB6",
        "reachabilityStatus": "Reachable",
        "neType": null,
        "lastReset": null,
        "resetReason": null,
        "sysContact": null,
        "sysDescr": "AIR-CAP3602I-E-K9",
        "sysLocation": null,
        "sysObjectId": "1.3.6.1.4.1.9.1.1069",
        "configRegister": null,
        "configAvailability": "Not Supported",
        "configCollectionDate": null,
        "imageName": null,
        "bootstrapVersion": "NA",
        "isManagedNe": 0,
        "userField1": null,
        "userField2": null,
        "userField3": null,
        "userField4": null,
        "macAddress": "00:06:28:d9:00:20"
    }
  ]
}

Software

The Software API returns details about the software installed on a device. All request parameters are optional other than “customerId”.

This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

URL

GET : https://apix.cisco.com/cs/api/v1/inventory/software

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/inventory/software?customerId=1234

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "managedNeInstanceId": 48325511,
        "inventoryName": "24OCT2017",
        "swType": null,
        "swVersion": "5.2",
        "swMajorVersion": "5.2",
        "swCategory": "SYSTEM",
        "swStatus": null,
        "swName": "UCOS"
    }
  ]
}