{"type":"api","title":"Get Discovered devices by range","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getDiscoveredDevicesByRange","tags":["Discovery"],"summary":"Get Discovered devices by range","deprecated":false,"description":"Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the \"Get Discoveries by range\" API.","parameters":[{"name":"id","description":"Discovery ID","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"startIndex","description":"Starting index for the records","required":true,"schema":{"type":"integer","default":"application/json"},"in":"path"},{"name":"recordsToReturn","description":"Number of records to fetch from the start index","required":true,"schema":{"type":"integer","default":"application/json"},"in":"path"},{"name":"taskId","description":"taskId","required":false,"schema":{"type":"string","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":{"anchorWlcForAp":{"type":"string","description":"Connected WLC device for AP"},"authModelId":{"type":"string","description":"Authentication model Id on device"},"avgUpdateFrequency":{"type":"integer","description":"Frequency in which interface info gets updated"},"bootDateTime":{"type":"string","description":"Device boot time"},"cliStatus":{"type":"string","description":"CLI status at the time of discovery"},"duplicateDeviceId":{"type":"string","description":"Identifier of the duplicate ip of the same device discovered"},"errorCode":{"type":"string","description":"Error code when inventory collection fails"},"errorDescription":{"type":"string","description":"Error description when inventory collection fails"},"family":{"type":"string","description":"Family of device as switch, router, wireless lan controller, accesspoints"},"hostname":{"type":"string","description":"Device name"},"httpStatus":{"type":"string","description":"HTTP(S) status at the time of discovery"},"id":{"type":"string","description":"Unique identifier of network device"},"imageName":{"type":"string","description":"Image details on the device"},"ingressQueueConfig":{"type":"string","description":"Ingress queue config on device"},"interfaceCount":{"type":"string","description":"Number of interfaces on the device"},"inventoryCollectionStatus":{"type":"string","description":"Last known collection status of the device. Available values are : 'Deleting Device', 'Partial Collection Failure', 'Yet to Sync', 'Could Not Synchronize', 'Not Manageable', 'Managed', 'Incomplete', 'Unreachable', 'In Progress', 'Maintenance', 'Sync Disabled', 'Quarantined', 'Unassociated', 'Unknown'"},"inventoryReachabilityStatus":{"type":"string","description":"Last known reachability status of the device. Available values are : 'Reachable', 'Unreachable', 'PingReachable' and 'NOT-AVAILABLE’"},"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"},"location":{"type":"string","description":"Location ID that is associated with the device"},"locationName":{"type":"string","description":"Name of the associated location"},"macAddress":{"type":"string","description":"MAC address of device"},"managementIpAddress":{"type":"string","description":"IP address of the device"},"memorySize":{"type":"string","description":"Processor memory size"},"netconfStatus":{"type":"string","description":"NETCONF status at the time of discovery. Available values are 'SUCCESS', 'FAILURE', 'NOT-PROVIDED' and 'NOT-VALIDATED'"},"numUpdates":{"type":"integer","description":"Number of time network-device info got updated"},"pingStatus":{"type":"string","description":"Ping status at the time of discovery. Available values are 'SUCCESS', 'FAILURE', 'NOT-PROVIDED' and 'NOT-VALIDATED'"},"platformId":{"type":"string","description":"Platform ID of device"},"portRange":{"type":"string","description":"Range of ports on device"},"qosStatus":{"type":"string","description":"Qos status on device"},"reachabilityFailureReason":{"type":"string","description":"Failure reason for unreachable devices"},"reachabilityStatus":{"type":"string","description":"Reachability status of a device as Success/Failure/Discarded"},"role":{"type":"string","description":"Role of device as access, distribution, border router, core"},"roleSource":{"type":"string","description":"Role source as manual / auto"},"serialNumber":{"type":"string","description":"Serial number of device"},"snmpContact":{"type":"string","description":"SNMP contact on device"},"snmpLocation":{"type":"string","description":"SNMP location on device"},"snmpStatus":{"type":"string","description":"SNMP status at the time of discovery"},"softwareVersion":{"type":"string","description":"Software version on the device"},"tag":{"type":"string","description":"Tag ID that is associated with the device"},"tagCount":{"type":"integer","description":"Number of tags associated with the device"},"type":{"type":"string","description":"Type of device as switch, router, wireless lan controller, accesspoints"},"upTime":{"type":"string","description":"Time that shows for how long the device has been up"},"vendor":{"type":"string","description":"Vendor information of the device"},"wlcApDeviceStatus":{"type":"string","description":"Collection status of AP devices"}}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetDiscoveredDevicesByRangeResponse"}}}},"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":"a6b7-98ab-4aca-a34e","x-rapi-overview":"Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the \"Get Discoveries by range\" API.","x-rapi-domain":"Operational Tasks","x-rapi-subdomain":"Discovery","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/discovery/${id}/network-device/${startIndex}/${recordsToReturn}","x-rapi-publicPath":"/dna/intent/api/v1/discovery/${id}/network-device/${startIndex}/${recordsToReturn}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getDiscoveredDevicesByRange","method":"get","path":"/dna/intent/api/v1/discovery/{id}/network-device/{startIndex}/{recordsToReturn}"}}