countSiteDevices
Count devices for a site, optionally grouped by the distinct field and filtered by device inventory attributes and time range. Use Count Org Devices to count devices across the organization.
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
uuidQuery Parameters
Field used to group this count response. enum: hostname, lldp_mgmt_addr, lldp_port_id, lldp_system_desc, lldp_system_name, map_id, model, mxedge_id, mxtunnel_status, version
"model"Value in
- "hostname"
- "lldp_mgmt_addr"
- "lldp_port_id"
- "lldp_system_desc"
- "lldp_system_name"
- "map_id"
- "model"
- "mxedge_id"
- "mxtunnel_status"
- "version"
Filter results by hostname
Filter results by device model
Filter results by MAC address
Filter results by software version
Filter AP results by Mist Tunnel status
Filter results by Mist Edge identifier
Filter AP results by LLDP system name
Filter AP results by LLDP system description
Filter AP results by LLDP port identifier
Filter AP results by LLDP management IP address
Filter results by map identifier
Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"Maximum number of results to return per page
0 <= value100Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/count"{ "distinct": "string", "end": 0, "limit": 0, "results": [ { "count": 0, "property": "string" } ], "start": 0, "total": 0}