searchSiteServicePathEvents
Search Service Path Events
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
Event type, e.g. GW_SERVICE_PATH_DOWN
Description of the event including the reason it is triggered
Port ID of the peer gateway
MAC address of the peer gateway
Filter results by vpn name
Filter results by vpn path
Service policy associated with that specific path
Filter results by port identifier
Filter results by device model
Filter results by software version
Filter results by MAC address
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/sites/000000ab-00ab-00ab-00ab-0000000000ab/services/events/search"{ "end": 1697096379, "limit": 10, "results": [ { "mac": "90ec7734b374", "model": "SSR120", "org_id": "a3c6718f-2823-4e48-bf5e-b841768a4c9b", "policy": "INTERNET", "port_id": "ge-1/0/6", "site_id": "4279edbd-1d24-41ea-9505-2eb26c8590fa", "text": "Peer Path Down", "timestamp": 1697037328.651775, "type": "GW_SERVICE_PATH_REMOVE", "version": "6.1.5-14.lts", "vpn_name": "Syracuse_HUB", "vpn_path": "Syracuse_HUB-Wan0" } ], "start": 1697009979, "total": 2}