Qodex.ai

searchSiteServicePathEvents

GET https://{{host}}/api/v1/sites/:site_id/services/events/search

Query Parameters

NameTypeDescription
typestringEvent type, e.g. GWSERVICEPATH_DOWN
textstringDescription of the event including the reason it is triggered
vpn_namestringPeer name
vpn_pathstringPeer path name
policystringService policy associated with that specific path
port_idstringNetwork interface
peer_port_idstringPort ID of the peer gateway
peer_macstringMAC address of the peer gateway
modelstringDevice model
versionstringDevice firmware version
timestamplongStart time, in epoch
org_idstringOrg id
site_idstringSite id
macstringMAC address

RESPONSES

status: OK

{"results":[{"timestamp":1697037334.204,"org_id":"a3c6718f-2823-4e48-bf5e-b841768a4c9b","site_id":"4279edbd-1d24-41ea-9505-2eb26c8590fa","port_id":"ge-0/0/0","model":"SSR120","type":"GW_SERVICE_PATH_DOWN","text":"Probe Down","version":"6.1.5-14.lts","mac":"90ec7734b374","policy":"management"},{"vpn_name":"Syracuse_HUB","timestamp":1697037328.651775,"org_id":"a3c6718f-2823-4e48-bf5e-b841768a4c9b","site_id":"4279edbd-1d24-41ea-9505-2eb26c8590fa","vpn_path":"Syracuse_HUB-Wan0","text":"Peer Path Down","port_id":"ge-1/0/6","model":"SSR120","type":"GW_SERVICE_PATH_REMOVE","version":"6.1.5-14.lts","mac":"90ec7734b374","policy":"INTERNET"},{"timestamp":1697037325.37843,"org_id":"a3c6718f-2823-4e48-bf5e-b841768a4c9b","site_id":"4279edbd-1d24-41ea-9505-2eb26c8590fa","port_id":"ge-1/0/6","model":"SSR120","type":"GW_SERVICE_PATH_ADD","version":"6.1.5-14.lts","mac":"90ec7734b374","policy":"policy1"}],"start":1697009979,"end":1697096379,"limit":10,"total":2}