{"type":"api","title":"Query the endpoints","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":"queryTheEndpoints","tags":["AI Endpoint Analytics"],"summary":"Query the endpoints","deprecated":false,"description":"Query the endpoints, optionally using various filter and pagination criteria. 'GET /endpoints/count' API can be used to find out the total number of endpoints matching the filter criteria.","parameters":[{"name":"profilingStatus","description":"Profiling status of the endpoint. Possible values are 'profiled', 'partialProfiled', 'notProfiled'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddress","description":"MAC address to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddresses","description":"List of MAC addresses to filter on. Only exact matches will be returned.","required":false,"schema":{"type":"array","default":"application/json","items":{"type":"string"}},"in":"query"},{"name":"ip","description":"IP address to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"deviceType","description":"Type of device to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"hardwareManufacturer","description":"Hardware manufacturer to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"hardwareModel","description":"Hardware model to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"operatingSystem","description":"Operating system to search for. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"registered","description":"Flag to fetch manually registered or non-registered endpoints.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"randomMac","description":"Flag to fetch endpoints having randomized MAC or not.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"trustScore","description":"Overall trust score of the endpoint. It can be provided either as a number value (e.g. 5), or as a range (e.g. 3-7). Provide value as '-' if you want to search for all endpoints where trust score is not assigned.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"authMethod","description":"Authentication method. Partial string is allowed.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"postureStatus","description":"Posture status.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"aiSpoofingTrustLevel","description":"Trust level of the endpoint due to AI spoofing. Possible values are 'low', 'medium', 'high'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"changedProfileTrustLevel","description":"Trust level of the endpoint due to changing profile labels. Possible values are 'low', 'medium', 'high'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"natTrustLevel","description":"Trust level of the endpoint due to NAT access. Possible values are 'low', 'medium', 'high'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"concurrentMacTrustLevel","description":"Trust level of the endpoint due to concurrent MAC address. Possible values are 'low', 'medium', 'high'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"ipBlocklistDetected","description":"Flag to fetch endpoints hitting IP blocklist or not.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"unauthPortDetected","description":"Flag to fetch endpoints exposing unauthorized ports or not.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"weakCredDetected","description":"Flag to fetch endpoints having weak credentials or not.","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"ancPolicy","description":"ANC policy. Only exact match will be returned.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"limit","description":"Maximum number of records to be fetched. If not provided, 50 records will be fetched by default. Maximum 1000 records can be fetched at a time. Use pagination if more records need to be fetched.\n","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"offset","description":"Record offset to start data fetch at. Offset starts at zero.","required":false,"schema":{"type":"integer","default":"application/json"},"in":"query"},{"name":"sortBy","description":"Name of the column to sort the results on. Please note that fetch might take more time if sorting is requested. Possible values are 'macAddress', 'ip'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"order","description":"Order to be used for sorting. Possible values are 'asc', 'desc'.","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"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. In case no records are found, 'items' attribute will contain empty array.","content":{"application/json":{"schema":{"type":"object","properties":{"totalResults":{"type":"integer","description":"Total number of records matching the given filter criteria."},"hasMoreResults":{"type":"boolean","description":"Flag to indicate whether more results are available than what is currently in the response."},"items":{"type":"array","items":{"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":"List of endpoints"}},"description":"","$$ref":"#/components/schemas/QueryTheEndpointsResponse"}}}},"400":{"description":"Invalid request. Check response body for more details.","content":{}},"500":{"description":"Internal server error. Check response body for more details.","content":{}}},"x-rapi-id":"aeb4-7a77-425b-b30f","x-rapi-overview":"Query the endpoints, optionally using various filter and pagination criteria. 'GET /endpoints/count' API can be used to find out the total number of endpoints matching the filter criteria.","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","x-rapi-publicPath":"/dna/intent/api/v1/endpoint-analytics/endpoints","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"queryTheEndpoints","method":"get","path":"/dna/intent/api/v1/endpoint-analytics/endpoints"}}