{"type":"api","title":"Get Events","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Events"],"description":"Get events for given query. If query is empty then last 30 mins data will be returned.","operationId":"getEvents","parameters":[{"name":"query","in":"query","description":"Query","allowEmptyValue":true,"schema":{"type":"string"},"examples":{"Empty":{"description":"Empty"},"Get events filter by system ip":{"description":"Get events filter by system ip","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"system_ip","operator":"in","type":"string","value":["1.1.1.1"]}]},"size":100},"$$ref":"#/components/examples/filter_by_system_ip"},"Get events filter by site-id":{"description":"Get events filter by site-id","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"site_id","operator":"in","type":"string","value":["400","500"]}]},"size":100},"$$ref":"#/components/examples/filter_by_sites"},"Get events filter by hours":{"description":"Get events filter by hours","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]}]},"size":100},"$$ref":"#/components/examples/filter_by_hours"},"Get events filter by severity":{"description":"Get events filter by severity","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"severity_level","operator":"in","type":"string","value":["critical"]}]},"size":100},"$$ref":"#/components/examples/filter_by_severity-2"},"Get events filter between dates":{"description":"Get events filter between dates","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["2024-04-30T19:30:00 UTC","2024-05-30T17:30:00 UTC"],"operator":"between"}]},"size":100},"$$ref":"#/components/examples/filter_between_dates-2"},"Get events filter by type":{"description":"Get events filter by type","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","operator":"last_n_hours","type":"date","value":["10"]},{"field":"eventname","operator":"in","type":"string","value":["memory-usage"]}]},"size":100},"$$ref":"#/components/examples/filter_by_type-2"}}},{"name":"page","in":"query","description":"Specify page number. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"pageSize","in":"query","description":"Specify page size. Value should be a positive integer","schema":{"type":"integer","format":"int64"}},{"name":"sortBy","in":"query","description":"Specify a field by which alarms need to be sorted","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"Select sorting order. Use ASC for ascending and DESC for descending","schema":{"type":"string"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}},{"name":"includeTenants","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Events":{"description":"Events","value":{"data":[{"system_ip":"172.16.255.11","vmanage_system_ip":"172.16.255.11","tenant":"default","device_type":"vedge","entry_time":1666259117528,"statcycletime":1666259117528,"eventname":"bfd-state-change","component":"BFD","severity_level":"major","host_name":"vm1","event":{"bfd-state-change":{"src-ip":"10.0.5.11","dst-ip":"10.1.16.16","local-system-ip":"172.16.255.11","src-port":12347,"system-ip":"172.16.255.11","dst-port":12346,"remote-color":"lte","host-name":"vm1","remote-system-ip":"172.16.255.16","severity-level":"major","local-color":"lte","xmlns":"http://viptela.com/bfd","deleted":false,"flap-reason":"na","proto":"ipsec","new-state":"down"}},"details":"host-name=vm1; src-ip=10.0.5.11; dst-ip=10.1.16.16; proto=ipsec; src-port=12347; dst-port=12346; local-system-ip=172.16.255.11; local-color=lte; remote-system-ip=172.16.255.16; remote-color=lte; new-state=down; deleted=false; flap-reason=na","id":"xh_I9IMBLPMz2to0aA3r"}],"pageInfo":{"startTime":"1589073783045","endTime":"1589072535795","count":15}},"$$ref":"#/components/examples/event"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read","__originalOperationId":"getEvents","method":"get","path":"/event"}}