Get Page Monitoring Events 1103 - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Page Monitoring Events 1103","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Events"],"description":"Get paginated events","operationId":"getPage_MonitoringEvents_1103","parameters":[{"name":"query","in":"query","description":"Query","schema":{"type":"string"},"examples":{"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/ComViptelaVmanageServerEventRequestFilterBySystemIp"},"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/ComViptelaVmanageServerEventRequestFilterBySites"},"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/ComViptelaVmanageServerEventRequestFilterByHours"},"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/ComViptelaVmanageServerEventRequestFilterBySeverity"},"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/ComViptelaVmanageServerEventRequestFilterBetweenDates"},"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/ComViptelaVmanageServerEventRequestFilterByType"}}},{"name":"scrollId","in":"query","description":"Scroll ID","schema":{"type":"string"}},{"name":"count","in":"query","description":"Number of alarms per page","schema":{"type":"integer","format":"int32"}},{"name":"site-id","in":"query","description":"Specify the site-id to filter the events","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"acknowledged":{"type":"boolean"},"active":{"type":"boolean"},"cleared_by":{"type":"string","format":"uuid","example":"0a0dca23-11d5-4014-bfbb-976d3c6de492"},"cleared_events":{"type":"array","items":{"type":"string","format":"uuid"}},"cleared_time":{"type":"integer","format":"int64","example":1652894923722},"component":{"type":"string","example":"Schedule Telemetry collection"},"consumed_events":{"type":"array","items":{"type":"object","$$ref":"#/components/schemas/OneOfAlarmConsumedEventsItems"}},"devices":{"type":"array","items":{"type":"object","properties":{"system-ip":{"type":"string","example":"19.19.19.1"}},"$$ref":"#/components/schemas/AlarmDevices"}},"entry_time":{"type":"integer","format":"int64","example":1652906591837},"eventname":{"type":"string","example":"telemetry-data-collection-failure"},"id":{"type":"string","example":"HHbp2IABUbH5BDy9BhJe"},"message":{"type":"string","example":"Scheduled telemetry data collection failed on 19.19.19.1"},"possible_causes":{"type":"array","items":{"type":"string"}},"receive_time":{"type":"integer","format":"int64"},"rule_name_display":{"type":"string","example":"Telemetry data save failed"},"rulename":{"type":"string","example":"cpu-usage"},"severity":{"type":"string","enum":["Minor","Major","Critical","Medium"]},"severity_number":{"type":"integer","format":"int64","example":4},"site_id":{"type":"integer","format":"int64","example":100},"statcycletime":{"type":"integer","format":"int64"},"suppressed":{"type":"boolean","example":false},"suppressed_by":{"type":"object","example":{"system-ip":{"type":"string","example":"172.16.255.11"},"component":{"type":"string","example":"BFD"}}},"system_ip":{"type":"string","example":"172.16.255.26"},"tenant":{"type":"string","example":"default"},"type":{"type":"string","example":"Telemetry data save failed"},"uuid":{"type":"string","format":"uuid","example":"f6f83721-3a69-42d1-841f-94e015957fb7"},"values":{"type":"array","items":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/GeneralSchema"}},"values_short_display":{"type":"array","items":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/GeneralSchema"}}},"description":"Represents any kind of alarm","$$ref":"#/components/schemas/Alarm"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"number of alarms to be fetched","format":"int64"},"endTime":{"type":"integer","description":"end time of alarms to be fetched","format":"int64"},"startTime":{"type":"integer","description":"start time of alarms to be fetched","format":"int64"}},"$$ref":"#/components/schemas/PageInfo"}},"description":"AlarmResponse is used for GET/POST /alarms call.","$$ref":"#/components/schemas/AlarmResponse"},"examples":{"Response":{"description":"Response","value":{"data":[{"entry_time":1717405624895,"statcycletime":1717405624895,"tenant":"default","deviceuuid":"91e86df6-8cd1-4a5d-99a9-0104b2960114","host_name":"vedge","system_ip":"172.16.255.11","vmanage_system_ip":"172.16.255.11","device_type":"vedge","eventname":"interface-state-change","component":"VPN","severity_level":"major","event":"{\"interface-state-change\":{\"if-name\":\"eth0\",\"xmlns\":\"http://viptela.com/vpn\",\"system-ip\":\"::\",\"host-name\":\"vedge\",\"vpn-id\":512,\"new-state\":\"up\",\"severity-level\":\"major\"}}","details":"host-name=vedge; vpn-id=512; if-name=eth0; new-state=up","tunnelname":"eth0","process_id":"","event_type":"","event_description":"","cor_region":"","cloud_type":"","transit_vpc_account_id":"","transit_vpc_account_name":"","transit_vpc_id":"","transit_vpc_name":"","host_vpc_id":"","host_vpc_account_id":"","host_vpc_account_name":"","instance_id":"","device_pair_id":"","device_uuid_list":"","device_instance_id_list":"","old_device_pair_id":"","target_device_ip":"","target_device_uuid":"","date_string":"","alert_timestamp":0,"filename":"","dst_port":0,"dst_ip":""}],"pageInfo":{"startTime":"1717405606203","endTime":"1717405624910","scrollId":"NQYkPL3cg2Y8fSMTClSW7MJ5e8A4ilV1vb7o0YhfJzHKS3hdaq6uOgIX2tUev4MV865y1txxwN6GU6XXg3hNX5dYrvKRfb4MeEUnc4pmkrgVwRUQnhUkZils","hasMoreData":true,"count":4,"totalCount":2728}},"$$ref":"#/components/examples/ComViptelaVmanageServerEventResponsePage"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Events-read","method":"get","path":"/event/page"}}