SitesRogues

listSiteRogueAPs

GET
/api/v1/sites/{site_id}/insights/rogues

Get List of Site Rogue/Neighbor APs

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid

Query Parameters

type?string

Rogue classification used to filter the results. enum: honeypot, lan, others, spoof

Value in

  • "honeypot"
  • "lan"
  • "others"
  • "spoof"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
interval?string

Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/insights/rogues"
{  "end": 1428954000,  "limit": 100,  "next": "/api/v1/sites/a3eda150-ab3f-11e4-aa18-13e21dd250cc/rogues?start=1498482000&end=1498485600&limit=10&interval=1h&type=others",  "results": [    {      "ap_mac": "5c5b350e021c",      "avg_rssi": -72,      "bssid": "d8-97-ba-76-b5-aa",      "channel": "11",      "num_aps": 4,      "ssid": "xfinitywifi",      "times_heard": 8    }  ],  "start": 1428939600}