{"type":"api","title":"Get endpoint details","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/167ffeffb0ddb8dfdcd104d49c529945120bad81/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":"getEndpointDetails","tags":["AI Endpoint Analytics"],"summary":"Get endpoint details","deprecated":false,"description":"Fetches details of the endpoint for the given unique identifier 'epId'.","parameters":[{"name":"epId","description":"Unique identifier for the endpoint.","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"},{"name":"include","description":"The datasets that should be included in the response. By default, value of this parameter is blank, and the response will include only basic details of the endpoint. To include other datasets or dictionaries, send comma separated list of following values: 'ALL' - Include all attributes. 'CDP', 'DHCP', etc. - Include attributes from given dictionaries. To get full list of dictionaries, use corresponding GET API. 'ANC' - Include ANC policy related details. 'TRUST' - Include trust score details.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the endpoint."},"duid":{"type":"string","description":"Unique DUID."},"macAddress":{"type":"string","description":"MAC address of the endpoint."},"deviceType":{"type":"array","items":{"type":"string"},"description":"Type of the device represented by this endpoint."},"hardwareManufacturer":{"type":"array","items":{"type":"string"},"description":"Hardware manufacturer for the endpoint."},"hardwareModel":{"type":"array","items":{"type":"string"},"description":"Hardware model of the endpoint."},"operatingSystem":{"type":"array","items":{"type":"string"},"description":"Operating system of the endpoint."},"lastProbeCollectionTimestamp":{"type":"integer","description":"Last probe collection timestamp in epoch milliseconds."},"randomMac":{"type":"boolean","description":"Flag to indicate whether MAC address is a randomized one or not."},"registered":{"type":"boolean","description":"Flag to indicate whether this is a manually registered endpoint or not."},"attributes":{"type":"object","properties":{},"description":"Various endpoint attributes grouped by dictionaries (e.g. IP, DHCP, etc)."},"trustData":{"type":"object","properties":{"trustScore":{"type":"integer","description":"Overall trust score of the endpoint."},"authMethod":{"type":"string","description":"Authentication method."},"postureStatus":{"type":"string","enum":["Compliant","Non-Compliant","Grace Compliant","Pending","Unknown"],"description":"Posture status."},"aiSpoofingTrustLevel":{"type":"string","enum":["low","medium","high"],"description":"Trust level of the endpoint due to AI spoofing."},"changedProfileTrustLevel":{"type":"string","enum":["low","medium","high"],"description":"Trust level of the endpoint due to changing profile labels."},"natTrustLevel":{"type":"string","enum":["low","medium","high"],"description":"Trust level of the endpoint due to NAT access."},"concurrentMacTrustLevel":{"type":"string","enum":["low","medium","high"],"description":"Trust level of the endpoint due to concurrent MAC address."},"ipBlocklistDetected":{"type":"boolean","description":"Flag to fetch endpoints hitting IP blocklist or not."},"unauthPortDetected":{"type":"boolean","description":"Flag to fetch endpoints exposing unauthorized ports or not."},"weakCredDetected":{"type":"boolean","description":"Flag to fetch endpoints having weak credentials or not."}},"description":""},"ancPolicy":{"type":"string","description":"ANC policy currently applied to the endpoint in ISE."},"granularAncPolicy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the granular ANC policy."},"nasIpAddress":{"type":"string","description":"IP address of the network device where endpoint is attached."}}},"description":"Granular ANC policy details."}},"description":"","$$ref":"#/components/schemas/GetEndpointDetailsResponse"}}}},"404":{"description":"Endpoint for the given 'epId' not found.","content":{}},"500":{"description":"Internal server error. Check response body for more details.","content":{}}},"x-rapi-id":"5881-9a5e-41a8-8cce","x-rapi-overview":"Fetches details of the endpoint for the given unique identifier 'epId'.","x-rapi-domain":"Policy","x-rapi-subdomain":"AI Endpoint Analytics","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/endpoint-analytics/v1/eps/endpoints/${epId}","x-rapi-publicPath":"/dna/intent/api/v1/endpoint-analytics/endpoints/${epId}","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"getEndpointDetails","method":"get","path":"/dna/intent/api/v1/endpoint-analytics/endpoints/{epId}"}}