{"type":"api","title":"Get Device Detail","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/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":"getDeviceDetail","tags":["Devices"],"summary":"Get Device Detail","deprecated":false,"description":"Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. ","parameters":[{"name":"timestamp","description":"UTC timestamp of device data in milliseconds","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"identifier","description":"One of \"macAddress\", \"nwDeviceName\", \"uuid\" (case insensitive)","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"searchBy","description":"MAC Address, device name, or UUID of the network device","required":true,"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":"object","properties":{"noiseScore":{"type":"integer","description":"Device (AP) WIFI signal noise health score"},"policyTagName":{"type":"string","description":"Device (AP) policy tag"},"interferenceScore":{"type":"integer","description":"Device (AP) WIFI signal interference health score"},"opState":{"type":"string","description":"Operation state of device (AP)"},"powerSaveMode":{"type":"string","description":"Device power save mode"},"mode":{"type":"string","description":"Device mode (AP)"},"resetReason":{"type":"string","description":"Device reset reason"},"nwDeviceRole":{"type":"string","description":"Device role"},"protocol":{"type":"string","description":"Protocol code"},"powerMode":{"type":"string","description":"Device's power mode"},"connectedTime":{"type":"string","description":"UTC timestamp"},"ringStatus":{"type":"boolean","description":"Device's ring status"},"ledFlashSeconds":{"type":"string","description":"LED flash seconds"},"ip_addr_managementIpAddr":{"type":"string","description":"Device's management IP address"},"stackType":{"type":"string","description":"Device stack type (applicable for stackable devices)"},"subMode":{"type":"string","description":"Device submode"},"serialNumber":{"type":"string","description":"Device serial number"},"nwDeviceName":{"type":"string","description":"Device name"},"deviceGroupHierarchyId":{"type":"string","description":"Device group site hierarchy UUID"},"cpu":{"type":"number","description":"Device CPU utilization"},"utilization":{"type":"string","description":"Device utilization"},"nwDeviceId":{"type":"string","description":"Device's UUID"},"siteHierarchyGraphId":{"type":"string","description":"Site hierarchy UUID in which device is assigned to"},"nwDeviceFamily":{"type":"string","description":"Device faimly string"},"macAddress":{"type":"string","description":"Device MAC address"},"homeApEnabled":{"type":"string","description":""},"deviceSeries":{"type":"string","description":"Device series string"},"collectionStatus":{"type":"string","description":"Device's telemetry data collection status for DNAC"},"utilizationScore":{"type":"integer","description":"Device utilization health score"},"maintenanceMode":{"type":"boolean","description":"Whether device is in maintenance mode"},"interference":{"type":"string","description":"Device (AP) WIFI signal interference"},"softwareVersion":{"type":"string","description":"Device's software version string"},"tagIdList":{"type":"array","items":{"type":"object"},"description":""},"powerType":{"type":"string","description":"Device (AP) power type"},"overallHealth":{"type":"integer","description":"Device's overall health score"},"managementIpAddr":{"type":"string","description":"Management IP address of the device"},"memory":{"type":"string","description":"Device memory utilization"},"communicationState":{"type":"string","description":"Device communication state"},"apType":{"type":"string","description":""},"adminState":{"type":"string","description":"Device (AP) admin state"},"noise":{"type":"string","description":"Device (AP) WIFI signal noise"},"icapCapability":{"type":"string","description":"Device (AP) ICAP capability bit values"},"regulatoryDomain":{"type":"string","description":"Device (AP) WIFI domain"},"ethernetMac":{"type":"string","description":"Device (AP) ethernet MAC address"},"nwDeviceType":{"type":"string","description":"Device type"},"airQuality":{"type":"string","description":"Device (AP) WIFI air quality"},"rfTagName":{"type":"string","description":"Device (AP) RF tag name"},"siteTagName":{"type":"string","description":"Device (AP) site tag name"},"platformId":{"type":"string","description":"Device's platform ID"},"upTime":{"type":"string","description":"Device up time"},"memoryScore":{"type":"integer","description":"Device's memory usage score"},"powerSaveModeCapable":{"type":"string","description":"Device (AP) power save mode capability"},"powerProfile":{"type":"string","description":"Device (AP) power profile name"},"airQualityScore":{"type":"integer","description":"Device (AP) air quality health score"},"location":{"type":"string","description":"Device's site hierarchy UUID"},"flexGroup":{"type":"string","description":"Deivce (A) flexconnect group"},"lastBootTime":{"type":"number","description":"Device's last boot UTC timestamp"},"powerCalendarProfile":{"type":"string","description":"Device (AP) power calendar profile name"},"connectivityStatus":{"type":"integer","description":"Device connectivity status"},"ledFlashEnabled":{"type":"string","description":"Device (AP) LED flash"},"cpuScore":{"type":"integer","description":"Device's CPU usage score"},"avgTemperature":{"type":"number","description":"Device's average temperature"},"maxTemperature":{"type":"number","description":"Device's max temperature"},"haStatus":{"type":"string","description":"Device's HA status"},"osType":{"type":"string","description":"Device's OS type"},"timestamp":{"type":"integer","description":"UTC timestamp of the device health data"},"apGroup":{"type":"string","description":"Device (AP) AP group"},"redundancyMode":{"type":"string","description":"Device redundancy mode"},"featureFlagList":{"type":"array","items":{"type":"string"},"description":"List of device feature capabilities"},"freeMbufScore":{"type":"integer","description":"Free memory buffer health score"},"HALastResetReason":{"type":"string","description":"Last HA reset reason"},"wqeScore":{"type":"integer","description":"WQE health score"},"redundancyPeerStateDerived":{"type":"string","description":""},"freeTimerScore":{"type":"integer","description":""},"redundancyPeerState":{"type":"string","description":""},"redundancyStateDerived":{"type":"string","description":"Derived redundancy state"},"redundancyState":{"type":"string","description":"Redundancy state"},"packetPoolScore":{"type":"integer","description":"Device packet pool health score"},"freeTimer":{"type":"number","description":"Free timer of the device"},"packetPool":{"type":"number","description":"Packet pool of the device"},"wqe":{"type":"number","description":"WQE of the device"},"freeMbuf":{"type":"number","description":"Free memory buffer of the device"}},"description":"Device detail response"}},"description":"Device detail data","$$ref":"#/components/schemas/GetDeviceDetailResponse"}}}},"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":"This user is forbidden to access this resource.","content":{}},"404":{"description":" The client made a request for a resource that does not exist.","content":{}},"500":{"description":" The server could not fulfill the request.","content":{}}},"x-rapi-id":"ca98-fac4-4b08-895c","x-rapi-overview":"Returns detailed Network Device information retrieved by Mac Address, Device Name or UUID for any given point of time. ","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/intent/deviceDetail","x-rapi-publicPath":"/dna/intent/api/v1/device-detail","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getDeviceDetail","method":"get","path":"/dna/intent/api/v1/device-detail"}}