SitesRogues

countSiteRogueEvents

GET
/api/v1/sites/{site_id}/rogues/events/count

Count by Distinct Attributes of Rogue Events

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

distinct?string

Field used to group this count response. enum: ap, bssid, ssid, type

Default"bssid"

Value in

  • "ap"
  • "bssid"
  • "ssid"
  • "type"
type?string

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

Value in

  • "honeypot"
  • "lan"
  • "others"
  • "spoof"
ssid?string

Filter results by SSID

bssid?string

Filter results by BSSID

ap_mac?string

MAC of the device that had strongest signal strength for ssid/bssid pair

channel?string

Filter results by channel

seen_on_lan?boolean

Whether the reporting AP see a wireless client (on LAN) connecting to it

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"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/rogues/events/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}