{"type":"api","title":"Get Device list","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"getDeviceList","tags":["Devices"],"summary":"Get Device list","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.","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"hostname","description":"hostname","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"managementIpAddress","description":"managementIpAddress","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"macAddress","description":"macAddress","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"locationName","description":"locationName","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"serialNumber","description":"serialNumber","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"location","description":"location","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"family","description":"family","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"type","description":"type","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"series","description":"series","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"collectionStatus","description":"collectionStatus","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"collectionInterval","description":"collectionInterval","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"notSyncedForMinutes","description":"notSyncedForMinutes","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"errorCode","description":"errorCode","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"errorDescription","description":"errorDescription","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"softwareVersion","description":"softwareVersion","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"softwareType","description":"softwareType","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"platformId","description":"platformId","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"role","description":"role","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"reachabilityStatus","description":"reachabilityStatus","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"upTime","description":"upTime","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"associatedWlcIp","description":"associatedWlcIp","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"license.name","description":"licenseName","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"license.type","description":"licenseType","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"license.status","description":"licenseStatus","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+name","description":"moduleName","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+equpimenttype","description":"moduleEqupimentType","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+servicestate","description":"moduleServiceState","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+vendorequipmenttype","description":"moduleVendorEquipmentType","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+partnumber","description":"modulePartNumber","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"module+operationstatecode","description":"moduleOperationStateCode","required":false,"type":"array","in":"query","items":{"type":"string"}},{"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,"type":"string","in":"query"},{"name":"deviceSupportLevel","description":"deviceSupportLevel","required":false,"type":"string","in":"query"},{"name":"offset","description":"offset \u003e= 1 [X gives results from Xth device onwards]","required":false,"type":"number","in":"query"},{"name":"limit","description":"1 \u003c= limit \u003c= 500 [max. no. of devices to be returned in the result]","required":false,"type":"number","in":"query"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","schema":{"type":"object","properties":{"response":{"type":"array","items":{"type":"object","properties":{"apManagerInterfaceIp":{"type":"string"},"associatedWlcIp":{"type":"string"},"bootDateTime":{"type":"string"},"collectionInterval":{"type":"string"},"collectionStatus":{"type":"string"},"errorCode":{"type":"string"},"errorDescription":{"type":"string"},"family":{"type":"string"},"hostname":{"type":"string"},"id":{"type":"string"},"instanceTenantId":{"type":"string"},"instanceUuid":{"type":"string"},"interfaceCount":{"type":"string"},"inventoryStatusDetail":{"type":"string"},"lastUpdateTime":{"type":"string"},"lastUpdated":{"type":"string"},"lineCardCount":{"type":"string"},"lineCardId":{"type":"string"},"location":{"type":"string"},"locationName":{"type":"string"},"macAddress":{"type":"string"},"managementIpAddress":{"type":"string"},"memorySize":{"type":"string"},"platformId":{"type":"string"},"reachabilityFailureReason":{"type":"string"},"reachabilityStatus":{"type":"string"},"role":{"type":"string"},"roleSource":{"type":"string"},"serialNumber":{"type":"string"},"series":{"type":"string"},"snmpContact":{"type":"string"},"snmpLocation":{"type":"string"},"softwareType":{"type":"string"},"softwareVersion":{"type":"string"},"tagCount":{"type":"string"},"tunnelUdpPort":{"type":"string"},"type":{"type":"string"},"upTime":{"type":"string"},"waasDeviceMode":{"type":"string"}}}},"version":{"type":"string"}},"$$ref":"#/definitions/NetworkDeviceListResult"}},"204":{"description":"The request was successful, however no content was returned."},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range."},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect)."},"401":{"description":"The client's authentication credentials included with the request are missing or invalid."},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"404":{"description":"The client made a request for a resource that does not exist."},"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."},"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)."},"500":{"description":"The server could not fulfill the request."},"501":{"description":"The server has not implemented the functionality required to fulfill the request."},"503":{"description":"The server is (temporarily) unavailable."},"504":{"description":"The server did not respond inside time restrictions and timed-out."}},"__originalOperationId":"getDeviceList","method":"get","path":"/dna/intent/api/v1/network-device"}}