{"type":"api","title":"Get Device Enrichment Details","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":"getDeviceEnrichmentDetails","tags":["Devices"],"summary":"Get Device Enrichment Details","deprecated":false,"description":"Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology","parameters":[{"name":"entity_type","description":"Device enrichment details can be fetched based on either Device ID or Device MAC address or Device IP Address. This parameter value must either be device_id/mac_address/ip_address","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"entity_value","description":"Contains the actual value for the entity type that has been defined","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"__persistbapioutput","description":"For the enrichment details to be made available as part of the API response, this header must be set to true. This header must be explicitly passed when called from client applications outside Catalyst Center","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"header"}],"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"deviceDetails":{"type":"object","properties":{"family":{"type":"string","description":"Device Family"},"type":{"type":"string","description":"Device Type"},"location":{"type":"object","properties":{},"description":"Device location - Site hierarchy"},"errorCode":{"type":"string","description":" Inventory status error code"},"macAddress":{"type":"string","description":"Device MAC address"},"role":{"type":"string","description":"Device role"},"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's last boot UTC timestamp"},"collectionStatus":{"type":"string","description":"Device's telemetry data collection status for DNAC"},"interfaceCount":{"type":"string","description":"Number of interfaces on the device"},"lineCardCount":{"type":"string","description":"Number of linecards on the device"},"lineCardId":{"type":"string","description":" IDs of linecards of the device"},"managementIpAddress":{"type":"string","description":"Device Management Ip Address"},"memorySize":{"type":"string","description":"Processor memory size"},"platformId":{"type":"string","description":"Device's platform ID"},"reachabilityFailureReason":{"type":"string","description":"Failure reason for unreachable devices"},"reachabilityStatus":{"type":"string","description":"Reachability Status of the Device(Reachable/Unreachable)"},"snmpContact":{"type":"string","description":"SNMP contact on device"},"snmpLocation":{"type":"string","description":"SNMP location on device"},"tunnelUdpPort":{"type":"object","properties":{},"description":"Mobility protocol port is stored as tunneludpport for WLC"},"waasDeviceMode":{"type":"object","properties":{},"description":"WAAS device mode"},"series":{"type":"string","description":"Device Series"},"inventoryStatusDetail":{"type":"string","description":"Status detail of inventory sync"},"collectionInterval":{"type":"string","description":"Re sync Interval of the device"},"serialNumber":{"type":"string","description":"Device Serial Number"},"softwareVersion":{"type":"string","description":"Device Software Version"},"roleSource":{"type":"string","description":"Role source as manual / auto"},"hostname":{"type":"string","description":"Device Hostname"},"upTime":{"type":"string","description":"Device's uptime"},"lastUpdateTime":{"type":"integer","description":"Time in epoch when the network device info last got updated"},"errorDescription":{"type":"string","description":"Inventory status description"},"locationName":{"type":"object","properties":{},"description":"[Deprecated] Name of the associated location"},"tagCount":{"type":"string","description":"Number of tags associated with the device"},"lastUpdated":{"type":"string","description":"Time when the network device info last got updated"},"instanceUuid":{"type":"string","description":"Instance Uuid of the device"},"id":{"type":"string","description":"Device's UUID"},"neighborTopology":{"type":"array","items":{"type":"object","properties":{"nodes":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","description":"Role of the Node"},"name":{"type":"string","description":"Hostname of the Node"},"id":{"type":"string","description":"Id of the Node"},"description":{"type":"string","description":"Description of the Node"},"deviceType":{"type":"string","description":"Device type of the node, like switch, AP, WCL,GateWay"},"platformId":{"type":"string","description":"Type of platform"},"family":{"type":"string","description":"Device Family of the Node"},"ip":{"type":"string","description":"IP Address of the Node"},"softwareVersion":{"type":"string","description":"Software Version of the Node"},"userId":{"type":"object","properties":{},"description":"User Id of the Node"},"nodeType":{"type":"string","description":"Type of the Node"},"radioFrequency":{"type":"object","properties":{},"description":"Frequency of wireless radio channel"},"clients":{"type":"object","properties":{},"description":"Number of clients"},"count":{"type":"object","properties":{},"description":"The number of group nodes (for ap sepecifically)"},"healthScore":{"type":"integer","description":"The total health score of the node"},"level":{"type":"number","description":"The level index to be used by UI widget (starts from 0)"},"fabricGroup":{"type":"object","properties":{},"description":"Fabric device group name"},"connectedDevice":{"type":"object","properties":{},"description":"The connected device to show the connected switch to wlc"}}},"description":""},"links":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","description":"Edge line starting node"},"linkStatus":{"type":"string","description":"The status of the link (up/down)"},"label":{"type":"array","items":{"type":"object"},"description":"The details of the edge"},"target":{"type":"string","description":"End node of the edge line"},"id":{"type":"object","properties":{},"description":"Id of the node"},"portUtilization":{"type":"object","properties":{},"description":"Number of clients"}}},"description":""}}},"description":""}},"description":""}}},"description":"","$$ref":"#/components/schemas/GetDeviceEnrichmentDetailsResponse"}}}},"202":{"description":"The request has been accepted for execution.","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":{}},"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":"e0b5-599b-4f29-97b7","x-rapi-overview":"Enriches a given network device context (device id or device Mac Address or device management IP address) with details about the device and neighbor topology","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~1","__originalOperationId":"getDeviceEnrichmentDetails","method":"get","path":"/dna/intent/api/v1/device-enrichment-details"}}