Get Trace History - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Get Trace History","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":["Troubleshooting Tools - Network Wide Path Insight"],"description":"Get historical traces","operationId":"getTraceHistory","parameters":[{"name":"traceModel","in":"query","description":"traceModel","schema":{"type":"string"},"examples":{"Get multiple types of traces with parameters separated by commas":{"description":"Get multiple types of traces with parameters separated by commas","value":"SDWAN_MANUAL,SDWAN_AUTO_ON,SD_ROUTING_MANUAL"},"Get auto on traces":{"description":"Get auto on traces","value":"SDWAN_AUTO_ON"},"Get manual traces":{"description":"Get manual traces","value":"SDWAN_MANUAL"},"Get sd-routing traces":{"description":"Get sd-routing traces","value":"SD_ROUTING_MANUAL"}}},{"name":"startTime","in":"query","description":"query start time","schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"query end time","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"object","properties":{"app-vis":{"type":"string"},"art-vis":{"type":"string"},"connectedVManages":{"type":"string"},"device-ip":{"type":"string"},"device-type":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"domain_monitor_can_be_started":{"type":"string"},"dscp-is-valid":{"type":"string"},"duration":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"expire-time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"parent-trace-id":{"type":"integer","format":"int32"},"qos-mon":{"type":"string"},"site-id":{"type":"string"},"source-site":{"type":"string"},"state":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"},"vpn-id":{"type":"string"}},"$$ref":"#/components/schemas/NwpiDomainMonitorStateRespPayloadDevicelist"}},"summary":{"type":"object","properties":{"agg-client-prefix":{"type":"string"},"agg-src-sgt":{"type":"string"},"agg-svr-prefix":{"type":"string"},"agg-user-name":{"type":"string"},"app":{"type":"string"},"app-grp":{"type":"string"},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"common_app":{"type":"string"},"device-ip":{"type":"string"},"devicesCheckInfo":{"type":"string"},"dia-vis":{"type":"string"},"domain-mon":{"type":"string"},"dscp":{"type":"string"},"dst-ip":{"type":"string"},"dst-pfx":{"type":"string"},"dst-pfx-len":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"health-app-server-mem":{"type":"string"},"health-cpu-core":{"type":"string"},"health-cpu-load":{"type":"string"},"health-cpu-load-average":{"type":"string"},"health-mem-usage":{"type":"string"},"health-running-traces":{"type":"integer","format":"int32"},"health-server-ip":{"type":"string"},"hub-wan-vis":{"type":"string"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"message":{"type":"string"},"protocol":{"type":"string"},"qos-mon":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"source-site-vmanage-version":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-ip":{"type":"string"},"src-pfx":{"type":"string"},"src-pfx-len":{"type":"string"},"src-port":{"type":"string"},"state":{"type":"string"},"stop-time":{"type":"integer","format":"int32"},"taskId":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"trace-trigger-event":{"type":"string"},"trace_stop_type":{"type":"string"},"username":{"type":"string"},"vpn-id":{"type":"string"},"vpn-list":{"type":"string"},"wan-drop-rate-threshold":{"type":"integer","format":"int32"},"warning":{"type":"string"}},"$$ref":"#/components/schemas/NwpiTraceHistoryRespPayloadDataSummary"}},"$$ref":"#/components/schemas/NwpiTraceHistoryRespPayloadData"},"entry_time":{"type":"integer","format":"int64"},"trace-id":{"type":"integer","format":"int32"},"type":{"type":"string"}},"description":"Nwpi traceHistory response payload schema","$$ref":"#/components/schemas/NwpiTraceHistoryRespPayload"},"examples":{"Response for getting historical traces":{"description":"Response for getting historical traces","value":{"header":{"generatedOn":1716888241874,"viewKeys":{"uniqueKey":[],"preferenceKey":"grid-nwpiTraceData"},"columns":[{"title":"Start Time","property":"entry_time","displayFormat":"DD MMM YYYY h:mm:ss A z","inputFormat":"unix-time","dataType":"date"},{"title":"Trace Id","property":"trace-id","dataType":"number"}],"fields":[{"property":"entry_time","dataType":"date"},{"property":"trace-id","dataType":"number"},{"property":"type","dataType":"string"},{"property":"data","dataType":"object"}]},"data":[{"trace-id":144,"entry_time":1716885120542,"traceModel":0,"type":"trace-history","data":{"summary":{"source-site":"500","device-ip":"N/A","vpn-id":"0","vpn-list":["1"],"src-if":"N/A","src-ip":"N/A","src-port":"N/A","dst-ip":"N/A","dst-port":"N/A","src-pfx":"N/A","src-pfx-len":"N/A","dst-pfx":"N/A","dst-pfx-len":"N/A","app":"N/A","username":"N/A","common_app":"N/A","app-grp":"N/A","protocol":"N/A","dscp":"N/A","duration":"60","trace-name":"trace_144","domain-mon":"disabled","qos-mon":"N/A","art-vis":"N/A","app-vis":"N/A","dia-vis":"N/A","hub-wan-vis":"N/A","sampling":"N/A","spl-intvl":"N/A","stop-time":-1,"source-site-vmanage-version":"20.15.0-50","taskId":-1,"trace-trigger-event":"N/A","enable-cmd-header":"N/A","state":"stopping","message":"Trace Stop initiated successfully (user stop), ready to notify devices","warning":"","wan-drop-rate-threshold":5,"local-drop-rate-threshold":5,"agg-client-prefix":"N/A","agg-svr-prefix":"N/A","agg-src-sgt":"N/A","agg-user-name":"N/A","health-server-ip":"172.16.255.22","health-cpu-load":"3.06","health-mem-usage":"44","health-cpu-load-average":"0.06","health-cpu-core":"16","health-app-server-mem":"0.09","health-running-traces":1,"trace_stop_type":"","devicesCheckInfo":[{"bfd-session-with-traffic":0,"up-bfd-session":18,"health-device-cpu-load":"30.56","health-device-mem-usage":"83","deviceHostName":"vm5-172.16.255.15","peerSitesCount":0}]},"devices":[{"entry_time":1716885120542,"device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","connectedVManages":"172.16.255.22","parent-trace-id":144,"domain_monitor_can_be_started":"true","source-site":"500","site-id":"500","message":"Device Trace Stop initiated successfully (received device reply ok)","vpn-id":"0","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","duration":"60","vpn-list":["1"],"trace-name":"trace_144","@rid":4365,"trace-id":144,"expire-time":1716888720542,"tenantId":"default","device-type":"src","state":"stopped","dscp-is-valid":"false"}]}}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-read,Device Monitoring-write","method":"get","path":"/stream/device/nwpi/traceHistory"}}