Get Device list - Cisco Catalyst Center API 2.3.7.4

{"type":"api","title":"Get Device list","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-4/5f0ebf004a2d4799bf23d5900695a35a48893d24/e3488c7c-70e3-3936-bce5-55e87fc57590","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.4","version":"2.3.7.4"},"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"getDeviceList","tags":["Devices"],"summary":"Get Device list","deprecated":false,"description":"Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search.\nFor example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request:\nGET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..*\n\nIf id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list.","parameters":[{"name":"hostname","description":"hostname","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"managementIpAddress","description":"managementIpAddress","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"macAddress","description":"macAddress","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"locationName","description":"locationName","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"serialNumber","description":"serialNumber","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"location","description":"location","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"family","description":"family","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"type","description":"type","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"series","description":"series","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"collectionStatus","description":"collectionStatus","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"collectionInterval","description":"collectionInterval","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"notSyncedForMinutes","description":"notSyncedForMinutes","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"errorCode","description":"errorCode","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"errorDescription","description":"errorDescription","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"softwareVersion","description":"softwareVersion","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"softwareType","description":"softwareType","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"platformId","description":"platformId","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"role","description":"role","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"reachabilityStatus","description":"reachabilityStatus","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"upTime","description":"upTime","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"associatedWlcIp","description":"associatedWlcIp","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"license.name","description":"licenseName","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"license.type","description":"licenseType","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"license.status","description":"licenseStatus","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+name","description":"moduleName","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+equpimenttype","description":"moduleEqupimentType","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+servicestate","description":"moduleServiceState","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+vendorequipmenttype","description":"moduleVendorEquipmentType","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+partnumber","description":"modulePartNumber","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"module+operationstatecode","description":"moduleOperationStateCode","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"id","description":"Accepts comma separated ids and return list of network-devices for the given ids. If invalid or not-found ids are provided, null entry will be returned in the list.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceSupportLevel","description":"deviceSupportLevel","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"offset","description":"offset \u003e= 1 [X gives results from Xth device onwards]","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"limit","description":"1 \u003c= limit \u003c= 500 [max. no. of devices to be returned in the result]","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"reachabilityFailureReason":{"type":"string","description":"Failure reason for unreachable devices"},"reachabilityStatus":{"type":"string","description":"Device reachability status as Reachable / Unreachable"},"series":{"type":"string","description":"Device series"},"snmpContact":{"type":"string","description":"SNMP contact on device"},"snmpLocation":{"type":"string","description":"SNMP location on device"},"tagCount":{"type":"string","description":"Number of tags associated with the device"},"tunnelUdpPort":{"type":"object","properties":{},"description":"Mobility protocol port is stored as tunneludpport for WLC"},"uptimeSeconds":{"type":"integer","description":"Uptime in Seconds"},"waasDeviceMode":{"type":"object","properties":{},"description":"WAAS device mode"},"serialNumber":{"type":"string","description":"Serial number of device"},"lastUpdateTime":{"type":"integer","description":"Time in epoch when the network device info last got updated"},"macAddress":{"type":"string","description":"MAC address of device"},"upTime":{"type":"string","description":"Time that shows for how long the device has been up"},"deviceSupportLevel":{"type":"string","description":"Support level of the device"},"hostname":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Type of device as switch, router, wireless lan controller, accesspoints"},"memorySize":{"type":"string","description":"Processor memory size"},"family":{"type":"string","description":"Family of device as switch, router, wireless lan controller, accesspoints"},"errorCode":{"type":"string","description":"Inventory status error code"},"softwareType":{"type":"string","description":"Software type on the device"},"softwareVersion":{"type":"string","description":"Software version on the device"},"description":{"type":"string","description":"System description"},"roleSource":{"type":"string","description":"Role source as manual / auto"},"location":{"type":"object","properties":{},"description":"[Deprecated] Location ID that is associated with the device"},"role":{"type":"string","description":"Role of device as access, distribution, border router, core"},"collectionInterval":{"type":"string","description":"Re sync Interval of the device"},"inventoryStatusDetail":{"type":"string","description":"Status detail of inventory sync"},"apEthernetMacAddress":{"type":"object","properties":{},"description":"AccessPoint Ethernet MacAddress of AP device"},"apManagerInterfaceIp":{"type":"string","description":"IP address of WLC on AP manager interface"},"associatedWlcIp":{"type":"string","description":"Associated Wlc Ip address of the AP device"},"bootDateTime":{"type":"string","description":"Device boot time"},"collectionStatus":{"type":"string","description":"Collection status as Synchronizing, Could not synchronize, Not manageable, Managed, Partial Collection Failure, Incomplete, Unreachable, Wrong credential, Reachable, In Progress"},"errorDescription":{"type":"string","description":"Inventory status description"},"interfaceCount":{"type":"string","description":"Number of interfaces on the device"},"lastUpdated":{"type":"string","description":"Time when the network device info last got updated"},"lineCardCount":{"type":"string","description":"Number of linecards on the device"},"lineCardId":{"type":"string","description":"IDs of linecards of the device"},"locationName":{"type":"object","properties":{},"description":"[Deprecated] Name of the associated location"},"managedAtleastOnce":{"type":"boolean","description":"Indicates if device went into Managed state atleast once"},"managementIpAddress":{"type":"string","description":"IP address of the device"},"platformId":{"type":"string","description":"Platform ID of device"},"managementState":{"type":"string","description":"Represents the current management state of the network element: managed, unmanaged, under maintenance, and so on."},"pendingSyncRequestsCount":{"type":"string","description":"Count of pending sync requests , if any"},"reasonsForDeviceResync":{"type":"string","description":"Reason for last/ongoing sync"},"reasonsForPendingSyncRequests":{"type":"string","description":"Reasons for pending sync requests , if any"},"dnsResolvedManagementAddress":{"type":"string","description":"Specifies the resolved ip address of dns name"},"lastDeviceResyncStartTime":{"type":"string","description":"Start time for last/ongoing sync"},"instanceTenantId":{"type":"string","description":"Instance Tenant Id of the device"},"instanceUuid":{"type":"string","description":"Instance Uuid of the device"},"id":{"type":"string","description":"Instance Uuid of the device"}},"required":["reachabilityStatus","series","tagCount","uptimeSeconds","waasDeviceMode","serialNumber","lastUpdateTime","macAddress","upTime","hostname","type","memorySize","family","softwareType","softwareVersion","role","inventoryStatusDetail","apEthernetMacAddress","collectionStatus","interfaceCount","lastUpdated","lineCardCount","lineCardId","managementIpAddress","platformId","managementState","reasonsForDeviceResync","dnsResolvedManagementAddress","lastDeviceResyncStartTime","instanceTenantId","instanceUuid","id"]},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/getDeviceListResponse"}}}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request.","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"20b1-9b52-464b-8972","x-rapi-overview":"Returns list of network devices based on filter criteria such as management IP address, mac address, hostname, etc. You can use the .* in any value to conduct a wildcard search.\nFor example, to find all hostnames beginning with myhost in the IP address range 192.25.18.n, issue the following request:\nGET /dna/intent/api/v1/network-device?hostname=myhost.*&managementIpAddress=192.25.18..*\n\nIf id parameter is provided with comma separated ids, it will return the list of network-devices for the given ids and ignores the other request parameters. You can also specify offset & limit to get the required list.","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/network-device","x-rapi-publicPath":"/dna/intent/api/v1/network-device","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getDeviceList","method":"get","path":"/dna/intent/api/v1/network-device"}}