{"type":"api","title":"Returns active rogue clients","meta":{"id":"/apps/pubhub/media/cisco-cmx-v11-0-0/c5aed5a4a2c41c993164672f27e8c5acda4dd890/984c8ace-1ab9-3c1d-89a9-c0650f6a37ef","info":{"title":"Location API","version":"1.0.0","description":"This is Location API. Use the Location based REST APIs to retrieve client location data programmatically from the Cisco CMX."},"openapi":"3.0.0","servers":[{"url":"/fakecmxserver"}]},"spec":{"operationId":"activeRogueClients","summary":"Returns active rogue clients","description":"This API supports searching by a variety of parameters. If no parameters are given then all active rogue clients are returned.\u003c/br\u003e\u003c/br\u003eThe API Username is set using the \u003cstrong\u003ecmxos apiserver user\u003c/strong\u003e command. This will change the username and password just for the Active V3 Rogue Clients API.\u003c/br\u003e\u003c/br\u003eHere are some examples to illustrate the queries. \u003c/br\u003e\u003c/br\u003e\u003cstrong\u003eSearch by IPv4/IPv6:\u003c/strong\u003e api/location/v3/rogueclients?ipAddress=x.x.x.x\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch by Mac Address:\u003c/strong\u003e api/location/v3/rogueclients?macAddress=x:x:x:x\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch by SSID:\u003c/strong\u003e api/location/v3/rogueclients?ssid=someSSID\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch by User Name:\u003c/strong\u003e api/location/v3/rogueclients?username=someUser\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch by Manufacturer:\u003c/strong\u003e api/location/v3/rogueclients?manufacturer=someManufacturer\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch for Only Associated Clients:\u003c/strong\u003e api/location/v3/rogueclients?associatedOnly=true\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch for Only Probing Clients:\u003c/strong\u003e api/location/v3/rogueclients?probingOnly=true\u003c/strong\u003e\u003cbr/\u003e\u003cstrong\u003eSearch by Map Hierarchy:\u003c/strong\u003e api/location/v3/rogueclients?mapHierarchy=someFloorName\u003c/strong\u003e\u003cbr/\u003eMap Hierarchy string can be partial string matches but any string used must be an exact match.\u003cbr/\u003e\u003cstrong\u003eSearch by Floor Id:\u003c/strong\u003e api/location/v3/rogueclients?floorId=x:x:x:x\u003c/strong\u003e\u003cbr/\u003e","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"},"example":{"notificationType":"locationupdate","subscriptionName":"CMX_Api_Server_Notification_1","eventId":7779817,"locationMapHierarchy":"System Campus\u003eWLC-244-43\u003eWLC-244-43-F1","locationCoordinate":{"x":49.0378,"y":26.800388,"z":0,"unit":"FEET"},"geoCoordinate":{"latitude":-999,"longitude":-999,"unit":"DEGREES"},"confidenceFactor":48,"apMacAddress":"NOT APPLICABLE","associated":false,"username":"NOT APPLICABLE","ipAddress":["NOT APPLICABLE"],"ssid":"NOT APPLICABLE","band":"NOT APPLICABLE","floorId":"727001524986708012","entity":"ROGUE_CLIENTS","deviceId":"50:32:37:e9:23:84","lastSeen":"2021-05-19T02:57:21.159-0700","rawLocation":{"rawX":-999,"rawY":-999,"unit":"FEET"},"tagVendorData":null,"bleTagInfo":null,"locComputeType":"RSSI","manufacturer":"Apple, Inc.","maxDetectedRssi":{"apMacAddress":"b0:8b:cf:54:5c:80","band":"IEEE_802_11_A","slot":0,"rssi":-37,"antennaIndex":0,"lastHeardInSeconds":2},"hierarchyDetails":{"campusParents":null,"campus":{"id":"1617954166291","name":"System Campus"},"building":{"id":"727001524986708011","name":"WLC-244-43"},"floor":{"id":"727001524986708012","name":"WLC-244-43-F1"},"zones":null},"rssiEntries":[{"apMacAddress":"b0:8b:cf:54:5c:80","band":"IEEE_802_11_A","slot":0,"antennaIndex":0,"rssi":-37,"lastHeardSecs":2},"…………."],"timestamp":1621418241159,"sourceNotification":"127.0.0.1","sourceNotificationKey":"127.0.0.1,3","notificationTime":"1621418241169","macAddress":"50:32:37:e9:23:84"}}}},"401":{"description":"Error Message","content":{"application/json":{"schema":{"type":"object"},"example":{"error":"CMX: System error"}}}}},"parameters":[{"name":"ipAddress","in":"query","required":false,"description":"Rogue Client IP address","schema":{"type":"string","default":""}},{"name":"macAddress","in":"query","required":false,"description":"Rogue Client MAC address","schema":{"type":"string","default":""}},{"name":"mapHierarchy","in":"query","required":false,"description":"Rogue Clients with MAP hierarchy string","schema":{"type":"string","default":""}},{"name":"ssid","in":"query","required":false,"description":"Rogue Clients associated on SSID","schema":{"type":"string","default":""}},{"name":"username","in":"query","required":false,"description":"Rogue Clients with user name","schema":{"type":"string","default":""}},{"name":"manufacturer","in":"query","required":false,"description":"Rogue Clients with manufacturer","schema":{"type":"string","default":""}},{"name":"macAddressSearch","in":"query","required":false,"description":"Rogue Clients MAC address search","schema":{"type":"string","default":""}},{"name":"associatedOnly","in":"query","required":false,"description":"Associated only rogue clients","schema":{"type":"string","default":""}},{"name":"probingOnly","in":"query","required":false,"description":"Probing only rogue clients","schema":{"type":"string","default":""}},{"name":"floorId","in":"query","required":false,"description":"Rogue Clients on floor ID","schema":{"type":"string","default":""}}],"__originalOperationId":"activeRogueClients","method":"get","path":"/location/v3/rogueclients"}}