{"type":"api","title":"Query the endpoints","meta":{"id":"/apps/pubhub/media/dna-center-235/0e427c513038595590fc5a0593cb0e208dd78571/2192edf3-d24e-3461-ab8c-12a97b547df4","swagger":"2.0","info":{"description":"Cisco DNA Center Platform v. 2.3.5","version":"2.3.5","title":"Intent API"},"schemes":["https"],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}}},"spec":{"operationId":"queryTheEndpoints","tags":["Policy"],"summary":"Query the endpoints","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.","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"profilingStatus","description":"Profiling status of the endpoint. Possible values are 'profiled', 'partialProfiled', 'notProfiled'.","required":false,"type":"string","in":"query"},{"name":"macAddress","description":"MAC address to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"macAddresses","description":"List of MAC addresses to filter on. Only exact matches will be returned.","required":false,"type":"array","in":"query","items":{"type":"string"}},{"name":"ip","description":"IP address to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"deviceType","description":"Type of device to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"hardwareManufacturer","description":"Hardware manufacturer to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"hardwareModel","description":"Hardware model to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"operatingSystem","description":"Operating system to search for. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"registered","description":"Flag to fetch manually registered or non-registered endpoints.","default":false,"required":false,"type":"boolean","in":"query"},{"name":"randomMac","description":"Flag to fetch endpoints having randomized MAC or not.","default":false,"required":false,"type":"boolean","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,"type":"string","in":"query"},{"name":"authMethod","description":"Authentication method. Partial string is allowed.","required":false,"type":"string","in":"query"},{"name":"postureStatus","description":"Posture status.","required":false,"type":"string","in":"query"},{"name":"aiSpoofingThreatLevel","description":"AI spoofing threat level of the endpoint. Possible values are 'low', 'medium', 'high'.","required":false,"type":"string","in":"query"},{"name":"changedProfileThreatLevel","description":"Threat level due to changing profile labels of the endpoint. Possible values are 'low', 'medium', 'high'.","required":false,"type":"string","in":"query"},{"name":"natThreatLevel","description":"NAT threat level of the endpoint. Possible values are 'low', 'medium', 'high'.","required":false,"type":"string","in":"query"},{"name":"concurrentMacThreatLevel","description":"Concurrent MAC threat level of the endpoint. Possible values are 'low', 'medium', 'high'.","required":false,"type":"string","in":"query"},{"name":"ipBlocklistDetected","description":"Flag to fetch endpoints hitting IP blocklist or not.","default":false,"required":false,"type":"boolean","in":"query"},{"name":"unauthPortDetected","description":"Flag to fetch endpoints exposing unauthorized ports or not.","default":false,"required":false,"type":"boolean","in":"query"},{"name":"weakCredDetected","description":"Flag to fetch endpoints having weak credentials or not.","default":false,"required":false,"type":"boolean","in":"query"},{"name":"ancPolicy","description":"ANC policy. Only exact match will be returned.","required":false,"type":"string","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,"type":"integer","in":"query"},{"name":"offset","description":"Record offset to start data fetch at. Offset starts at zero.","required":false,"type":"integer","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,"type":"string","in":"query"},{"name":"order","description":"Order to be used for sorting. Possible values are 'asc', 'desc'.","required":false,"type":"string","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,"type":"string","in":"query"}],"responses":{"200":{"description":"Success. In case no records are found, 'items' attribute will contain empty array.","schema":{"type":"object","properties":{"totalResults":{"type":"integer"},"hasMoreResults":{"type":"boolean"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"duid":{"type":"string"},"macAddress":{"type":"string"},"deviceType":{"type":"array","items":{"type":"string"}},"hardwareManufacturer":{"type":"array","items":{"type":"string"}},"hardwareModel":{"type":"array","items":{"type":"string"}},"operatingSystem":{"type":"array","items":{"type":"string"}},"lastProbeCollectionTimestamp":{"type":"integer"},"randomMac":{"type":"boolean"},"registered":{"type":"boolean"},"attributes":{"type":"object","properties":{}},"trustData":{"type":"object","properties":{"trustScore":{"type":"integer"},"authMethod":{"type":"string"},"postureStatus":{"type":"string","enum":["Compliant","Non-Compliant","Grace Compliant","Pending","Unknown"]},"aiSpoofingThreatLevel":{"type":"string","enum":["low","medium","high"]},"changedProfileThreatLevel":{"type":"string","enum":["low","medium","high"]},"natThreatLevel":{"type":"string","enum":["low","medium","high"]},"concurrentMacThreatLevel":{"type":"string","enum":["low","medium","high"]},"ipBlocklistDetected":{"type":"boolean"},"unauthPortDetected":{"type":"boolean"},"weakCredDetected":{"type":"boolean"}}},"ancPolicy":{"type":"string"},"granularAncPolicy":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"nasIpAddress":{"type":"string"}}}}}}}},"$$ref":"#/definitions/Endpoints"}},"400":{"description":"Invalid request. Check response body for more details."},"500":{"description":"Internal server error. Check response body for more details."}},"__originalOperationId":"queryTheEndpoints","method":"get","path":"/dna/intent/api/v1/endpoint-analytics/endpoints"}}