searchOrgDeviceEvents
Search device event records across the organization with filters for MAC address, model, device type, event text, event type, additional event indices, and time range.
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
Filter results by MAC address. Accepts multiple comma-separated values.
Filter results by device model. Accepts multiple comma-separated values.
Filter results by device type. Accepts multiple comma-separated values.
"ap"Filter results by event message text
See List Device Events Definitions. Accepts multiple comma-separated values.
Return last/recent event for passed in field
Keyword to include events from additional indices (e.g. ext_tunnel for ext tunnel events)
Maximum number of results to return per page
0 <= value100Lower 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"On which field the list should be sorted, -prefix represents DESC order
"timestamp"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/events/search?device_type=switch%2Cap"{ "end": 0, "limit": 0, "next": "string", "results": [ { "ap": "5c5b351e13b5", "apfw": "5c5b351e13b5", "model": "BT11-WW", "org_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862a", "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b", "text": "Succeeding DNS query from 172.29.101.134 to 172.29.101.7 for \"portal.mistsys.com\" on vlan 1, id 60224", "timestamp": 1547235620.89, "type": "CLIENT_DNS_OK" }, { "device_type": "gateway", "job_id": "c2096de9-0ca4-4a8b-b500-d37cbe0f0baf", "mac": "d007ca6c6ac0", "org_id": "86f0c649-06b1-4337-b3d4-25eeb887f732", "site_id": "9f8d28eb-77c7-44c7-a85b-4426bf291679", "status": "PROVISION_IN_PROGRESS", "template_id": "660e8400-e29b-41d4-a716-446655440001", "timestamp": 1748987445.959, "tunnel_name": "zs1", "type": "NOTICE" } ], "start": 0, "total": 0}listOrgDevicesSummary GET
Return aggregate organization device counts by device category and assignment state.
searchOrgDeviceLastConfigs GET
Search device config history records across the organization with filters for device type, MAC address, name, software version, certificate-expiry duration, and time range.