{"type":"api","title":"Trace Start","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":"Trace Action - Start","operationId":"traceStart","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"app":{"type":"array","items":{"type":"string"}},"app-vis":{"type":"string"},"art-vis":{"type":"string"},"dia-vis":{"type":"string"},"dscp":{"type":"string"},"dst-pfx":{"type":"string"},"dst-port":{"type":"string"},"duration":{"type":"string"},"hub-wan-vis":{"type":"string"},"protocol":{"type":"string"},"sampling":{"type":"string"},"source-site":{"type":"string"},"spl-intvl":{"type":"string"},"src-if":{"type":"string"},"src-pfx":{"type":"string"},"src-port":{"type":"string"},"trace-name":{"type":"string"},"vpn-id":{"type":"string"}},"description":"Trace start payload schema","$$ref":"#/components/schemas/NwpiTraceStartReqPayload"},"examples":{"Start trace simply":{"description":"Start trace simply","value":{"source-site":"500","duration":"60","vpn-id":"1"}},"Start trace simply (use vpn-list)":{"description":"Start trace simply (use vpn-list)","value":{"source-site":"500","duration":"60","vpn-list":["1"]}},"Start trace simply (UI default paramters)":{"description":"Start trace simply (UI default paramters)","value":{"source-site":"500","duration":"60","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","transport-interface":[]}],"vpn-id":"1","art-vis":"true","app-vis":"true","qos-mon":"true","source-site-version":"17.15","traceModel":"SDWAN_MANUAL","warning":""}},"Start trace with synthetic traffic":{"description":"Start trace with synthetic traffic","value":{"source-site":"500","duration":"60","local-drop-rate-threshold":5,"wan-drop-rate-threshold":5,"device-list":[{"local-system-ip":"172.16.255.15","deviceId":"172.16.255.15","uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","version":"17.15.01.0.727","transport-interface":[]}],"vpn-id":"1","test":[{"target-url":"www.chatgpt.com","dscp":"0","test-intvl":"1","dns-svr":"8.8.8.8","vpn-id":"1","username":"","user_grp":""}],"art-vis":"true","app-vis":"true","qos-mon":"true","source-site-version":"17.15","traceModel":"SDWAN_MANUAL","warning":""}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string"},"domain-mon":{"type":"boolean"},"entry_time":{"type":"integer","format":"int64"},"expire-time":{"type":"integer","format":"int64"},"local-drop-rate-threshold":{"type":"integer","format":"int32"},"qos-mon":{"type":"boolean"},"source-site":{"type":"string"},"state":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"trace-name":{"type":"string"},"traces":{"type":"array","items":{"type":"object","properties":{"device-ip":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/NwpiTraceStartRespPayloadTraces"}},"wan-drop-rate-threshold":{"type":"integer","format":"int32"}},"description":"Nwpi trace start response payload schema","$$ref":"#/components/schemas/NwpiTraceStartRespPayload"},"examples":{"Start trace simply":{"description":"Start trace simply","value":{"action":"success","qos-mon":true,"source-site":"500","trace-id":80,"trace-name":"trace_80","traceModel":0,"entry_time":1716789542704,"expire-time":1716793142704,"state":"starting","traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":80,"entry_time":1716789542704,"status":"success","message":"Trace Starting"}],"domain-mon":false,"local-drop-rate-threshold":5,"wan-drop-rate-threshold":5}},"Start trace simply (UI default paramters)":{"description":"Start trace simply (UI default paramters)","value":{"action":"success","qos-mon":true,"source-site":"500","trace-id":96,"trace-name":"trace_96","traceModel":0,"entry_time":1716790090943,"expire-time":1716793690943,"state":"starting","traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":96,"entry_time":1716790090943,"status":"success","message":"Trace Starting"}],"domain-mon":false,"local-drop-rate-threshold":5,"wan-drop-rate-threshold":5}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Device Monitoring-write","method":"post","path":"/stream/device/nwpi/trace/start"}}