{"type":"api","title":"Get Client 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":"getClientDetail","tags":["Clients"],"summary":"Get Client Detail","deprecated":false,"description":"Returns detailed Client information retrieved by Mac Address for any given point of time. ","parameters":[{"name":"macAddress","description":"MAC Address of the client","required":true,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"timestamp","description":"Epoch time(in milliseconds) when the Client health data is required","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":{"detail":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier representing a specific host"},"connectionStatus":{"type":"string","description":"The client is connected, connecting, or disconnected"},"tracked":{"type":"string","description":"Tracking status of this host"},"hostType":{"type":"string","enum":["wired","wireless"],"description":"WIRED or WIRELESS"},"userId":{"type":"string","description":"The user ID of this host"},"duid":{"type":"string","description":"Device UID for MAC"},"identifier":{"type":"string","description":"The host's unique identifier, which is populated by and in order of userId, hostName, hostIpV4, hostIpV6, or hostMac"},"hostName":{"type":"string","description":"The hostname of the host"},"hostOs":{"type":"string","description":"The OS of host"},"hostVersion":{"type":"string","description":"The version of OS of host"},"subType":{"type":"string","description":"The device type of host"},"firmwareVersion":{"type":"string","description":"The firmware version of the host"},"deviceVendor":{"type":"string","description":"The device vendor string"},"deviceForm":{"type":"string","description":"The device form of the host (e.g. Phone/Tablet)"},"salesCode":{"type":"string","description":"The Sales Code of the host"},"countryCode":{"type":"string","description":"The country code of the host"},"lastUpdated":{"type":"integer","description":"Epoch/Unix time in milliseconds"},"healthScore":{"type":"array","items":{"type":"object","properties":{"healthType":{"type":"string","description":"Type of device health"},"reason":{"type":"string","description":"Reason for the health score value"},"score":{"type":"integer","description":"health score of client device in the range of 1 to 10. Value 0 for a client represents an IDLE client"}}},"description":"A list of health score object"},"hostMac":{"type":"string","description":"MAC address of the interface"},"hostIpV4":{"type":"string","description":"IPv4 address of the interface"},"hostIpV6":{"type":"array","items":{"type":"string"},"description":"List of IPv6 addresses"},"authType":{"type":"string","description":"Authentication mechanism of the client"},"vlanId":{"type":"integer","description":"VLAN ID for the host"},"l3VirtualNetwork":{"type":"string","description":"Comma separated Level 3 virtual network names"},"l2VirtualNetwork":{"type":"string","description":"Comma separated Level 2 virtual network names"},"vnid":{"type":"integer","description":"VNID of the host"},"upnId":{"type":"string","description":"Registered UPN ID of the host"},"upnName":{"type":"string","description":"Registered UPN name of the host"},"ssid":{"type":"string","description":"WLAN SSID to which the client is connected"},"frequency":{"type":"string","description":"Frequency band to which the client is connected"},"channel":{"type":"string","description":"Channel to which the client is connected"},"apGroup":{"type":"string","description":"AP group to which the client belongs"},"sgt":{"type":"string","description":"Security group tag"},"location":{"type":"string","description":"Site location of client"},"clientConnection":{"type":"string","description":"AP/Switch to which the client is connected"},"connectedDevice":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of device (AP or SWITCH)"},"name":{"type":"string","description":"Name of the device"},"mac":{"type":"string","description":"MAC address of the access point"},"id":{"type":"string","description":"Unique identifier of the device"},"ip address":{"type":"string","description":"Management IP address of the connected device. (deprecated soon in favor of 'mgmtIp')"},"mgmtIp":{"type":"string","description":"The IP address of the connected device"},"band":{"type":"string","description":"Band of the AP"},"mode":{"type":"string","description":"The mode of the access point"}}},"description":"A list of connected devices"},"issueCount":{"type":"integer","description":"Issue count for a device"},"rssi":{"type":"string","description":"Min RSSI value for the client"},"rssiThreshold":{"type":"string","description":"RSSI threshold"},"rssiIsInclude":{"type":"string","description":"RSSI include/exclude flag"},"avgRssi":{"type":"string","description":"Average RSSI value for the client"},"snr":{"type":"string","description":"Min signal to noise ratio for the client"},"snrThreshold":{"type":"string","description":"SNR threshold"},"snrIsInclude":{"type":"string","description":"SNR include/exclude flag"},"avgSnr":{"type":"string","description":"Average signal to noise ratio for a client"},"dataRate":{"type":"string","description":"MCS data rates for a client"},"txBytes":{"type":"string","description":"total transmitted bytes for a client"},"rxBytes":{"type":"string","description":"Total received bytes for a client"},"dnsResponse":{"type":"string","description":"DNS response attempts for a client"},"dnsRequest":{"type":"string","description":"DNS request attempts for a client"},"onboarding":{"type":"object","properties":{"averageRunDuration":{"type":"string","description":"Average run Duration for a client"},"maxRunDuration":{"type":"string","description":"Max run duration for a client"},"averageAssocDuration":{"type":"string","description":"Average association duration for a client"},"maxAssocDuration":{"type":"string","description":"Max association duration for a client"},"averageAuthDuration":{"type":"string","description":"Average auth duration for a client"},"maxAuthDuration":{"type":"string","description":"Max auth duration for a client"},"averageDhcpDuration":{"type":"string","description":"Average DHCP duration for a client"},"maxDhcpDuration":{"type":"string","description":"Max DHCP duration for a client"},"aaaServerIp":{"type":"string","description":"AAA server IP for a client"},"dhcpServerIp":{"type":"string","description":"DHCP server IP for a client"},"authDoneTime":{"type":"integer","description":"Epoch/Unix time in milliseconds"},"assocDoneTime":{"type":"integer","description":"Epoch/Unix time in milliseconds"},"dhcpDoneTime":{"type":"integer","description":"Epoch/Unix time in milliseconds"},"assocRootcauseList":{"type":"array","items":{"type":"string"},"description":"Root cause list of ASSOC failure category"},"aaaRootcauseList":{"type":"array","items":{"type":"string"},"description":"Root cause list of AAA failure category"},"dhcpRootcauseList":{"type":"array","items":{"type":"string"},"description":"Root cause list of DHCP failure category"},"otherRootcauseList":{"type":"array","items":{"type":"string"},"description":"Root cause list of other failure category"},"latestRootCauseList":{"type":"array","items":{"type":"string"},"description":"Root cause list of latest root cause category"}},"description":"Onboarding data for the client"},"clientType":{"type":"string","description":"OLD or NEW"},"onboardingTime":{"type":"integer","description":"Epoch/Unix time in milliseconds"},"port":{"type":"string","description":"switch port for client"},"iosCapable":{"type":"boolean","description":""},"usage":{"type":"number","description":"Usage of txBytes and rxBytes of client"},"linkSpeed":{"type":"number","description":"The speed of wired client"},"linkThreshold":{"type":"string","description":"Link error threshold of wired client"},"remoteEndDuplexMode":{"type":"string","description":"The remote end duplex mode of wired client"},"txLinkError":{"type":"number","description":"The error of tx link"},"rxLinkError":{"type":"number","description":"The error of rx link"},"txRate":{"type":"number","description":"The rate of tx"},"rxRate":{"type":"number","description":"The rate of rx"},"rxRetryPct":{"type":"string","description":"The retry count as percentage wrt to total rx packets"},"versionTime":{"type":"integer","description":"The metric modification time of the new version"},"dot11Protocol":{"type":"string","description":"Description of dot11 protocol"},"slotId":{"type":"integer","description":"Slot ID of AP which client is connected"},"dot11ProtocolCapability":{"type":"string","description":"description of dot11 protocol capability"},"privateMac":{"type":"boolean","description":""},"dhcpServerIp":{"type":"string","description":"The DHCP server IP"},"aaaServerIp":{"type":"string","description":"The AAA server IP"},"aaaServerTransaction":{"type":"integer","description":"The number of AAA server transactions"},"aaaServerFailedTransaction":{"type":"integer","description":"The number of failed AAA server transactions"},"aaaServerSuccessTransaction":{"type":"integer","description":"The number of successful AAA server transactions"},"aaaServerLatency":{"type":"number","description":"The AAA server latency"},"aaaServerMABLatency":{"type":"number","description":"The AAA server MAB latency"},"aaaServerEAPLatency":{"type":"number","description":"The AAA server EAP latency"},"dhcpServerTransaction":{"type":"integer","description":"The number of DHCP server transactions"},"dhcpServerFailedTransaction":{"type":"integer","description":"The number of failed DHCP server transactions"},"dhcpServerSuccessTransaction":{"type":"integer","description":"The number of successful DHCP server transactions"},"dhcpServerLatency":{"type":"number","description":"The DHCP server latency"},"dhcpServerDOLatency":{"type":"number","description":"The DHCP server DO latency"},"dhcpServerRALatency":{"type":"number","description":"The DHCP RA latency"},"maxRoamingDuration":{"type":"string","description":"Max roaming duration for a client"},"upnOwner":{"type":"string","description":"Owner of registered UPN name"},"connectedUpn":{"type":"string","description":"connected UPN ID"},"connectedUpnOwner":{"type":"string","description":"Connected UPN owner"},"connectedUpnId":{"type":"string","description":"Connected UPN ID"},"isGuestUPNEndpoint":{"type":"boolean","description":"Whether it is guest UPN endpoint"},"wlcName":{"type":"string","description":"The name of the connected wireless controller"},"wlcUuid":{"type":"string","description":"UUID of the WLC the client connected to"},"sessionDuration":{"type":"string","description":"Time duration the session took from run time to delete time"},"intelCapable":{"type":"boolean","description":"Whether support Intel device analytics"},"hwModel":{"type":"string","description":"Hardware model"},"powerType":{"type":"string","description":"AC/DC voltage"},"modelName":{"type":"string","description":"System model"},"bridgeVMMode":{"type":"string","description":"Bridge VM mode"},"dhcpNakIp":{"type":"string","description":"DHCP NAK IP"},"dhcpDeclineIp":{"type":"string","description":"DHCP decline IP"},"portDescription":{"type":"string","description":"Port desctiption of wired client"},"latencyVoice":{"type":"number","description":"Voice latency"},"latencyVideo":{"type":"number","description":"Video latency"},"latencyBg":{"type":"number","description":"Background latency"},"latencyBe":{"type":"number","description":"Best-effort latency"},"trustScore":{"type":"string","description":"Trust score of Client received from EndPoint Analytics"},"trustDetails":{"type":"string","description":"Trust details explaining reason for corresponding Trust score"}},"description":""},"connectionInfo":{"type":"object","properties":{"hostType":{"type":"string","description":"Host Type - WIRELESS or WIRED"},"nwDeviceName":{"type":"string","description":"Name of the network device it is connected to. In case of wireless, it would be an AccessPoint"},"nwDeviceMac":{"type":"string","description":"Device MAC address"},"protocol":{"type":"string","description":"Connection Protocol used. This information is present for wireless hosts only"},"band":{"type":"string","description":"The band at which the host is connected. This information is present for wireless hosts only"},"spatialStream":{"type":"string","description":"The spatial stream of host. This information is present for wireless hosts only"},"channel":{"type":"string","description":"The channel used by the host. This information is present for wireless hosts only"},"channelWidth":{"type":"string","description":"The channel width used by the host. This information is present for wireless hosts only"},"wmm":{"type":"string","description":"The wmm of the host. This information is present for wireless hosts only"},"uapsd":{"type":"string","description":"The UAPSD of the host. This information is present for wireless hosts only"},"timestamp":{"type":"integer","description":"Epoch/Unix time in milliseconds"}},"description":""},"topology":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"Device role"},"name":{"type":"string","description":"Device name"},"id":{"type":"string","description":"User ID, hostname, IP address, or MAC address"},"description":{"type":"string","description":"Description of the topology node"},"deviceType":{"type":"string","description":"Device type"},"platformId":{"type":"string","description":"Device platform ID"},"family":{"type":"string","description":"Device family"},"ip":{"type":"string","description":"Device IP"},"ipv6":{"type":"array","items":{"type":"string"},"description":"Device IPv6"},"softwareVersion":{"type":"string","description":"Device software version"},"userId":{"type":"string","description":"User ID"},"nodeType":{"type":"string","description":"Node type"},"radioFrequency":{"type":"string","description":"Radio frequency"},"clients":{"type":"number","description":"Number of clients"},"count":{"type":"integer","description":""},"healthScore":{"type":"number","description":"Device health score"},"level":{"type":"number","description":"Level in the topology"},"fabricGroup":{"type":"string","description":"Fabric Group"},"fabricRole":{"type":"array","items":{"type":"string"},"description":"Fabric Role"},"connectedDevice":{"type":"string","description":""},"stackType":{"type":"string","description":""}}},"description":"Nodes of the topology"},"links":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"Edge line starting node"},"linkStatus":{"type":"string","description":"Link status of the link"},"sourceLinkStatus":{"type":"string","description":"The status of the link"},"targetLinkStatus":{"type":"string","description":"The status of the link"},"label":{"type":"array","items":{"type":"string"},"description":"The details of the edge"},"target":{"type":"string","description":"End node of the edge line"},"id":{"type":"string","description":"Identifier of the node"},"portUtilization":{"type":"number","description":"Port utilization"},"sourceInterfaceName":{"type":"string","description":"The interface name of the source"},"targetInterfaceName":{"type":"string","description":"The interface name of the target"},"sourceDuplexInfo":{"type":"string","description":"The duplex info of the source"},"targetDuplexInfo":{"type":"string","description":"The duplex info of the target"},"sourcePortMode":{"type":"string","description":"The port mode of the source"},"targetPortMode":{"type":"string","description":"The port mode of the target"},"sourceAdminStatus":{"type":"string","description":"The admin status of the source"},"targetAdminStatus":{"type":"string","description":"The admin status of the target"},"apRadioAdminStatus":{"type":"string","description":"The admin status of the radio"},"apRadioOperStatus":{"type":"string","description":"The oper status of the radio"},"sourcePortVLANInfo":{"type":"string","description":"List of VLANs configured on the source port"},"targetPortVLANInfo":{"type":"string","description":"List of VLANs configured on the target port"},"interfaceDetails":{"type":"array","items":{"type":"object","properties":{"clientMacAddress":{"type":"string","description":"The MAC address of the client device"},"connectedDeviceIntName":{"type":"string","description":"The interface name of the network device"},"duplex":{"type":"string","description":"The duplex info of the network device interface"},"portMode":{"type":"string","description":"The port mode info of network device interface"},"adminStatus":{"type":"string","description":"The admin status of network device interface"}}},"description":"Interface detail information"}}},"description":"Links of the topology"}},"description":""}},"description":"","$$ref":"#/components/schemas/GetClientDetailResponse"}}}},"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":"1980-1996-4389-9d65","x-rapi-overview":"Returns detailed Client information retrieved by Mac Address for any given point of time. ","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Clients","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/assurance/v1/intent/clientDetail","x-rapi-publicPath":"/dna/intent/api/v1/client-detail","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getClientDetail","method":"get","path":"/dna/intent/api/v1/client-detail"}}