{"type":"api","title":"Trace Stop","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 - Stop","operationId":"traceStop","parameters":[{"name":"traceId","in":"path","description":"traceId","required":true,"schema":{"type":"string","example":"48"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string"},"domain-mon":{"type":"boolean"},"entry_time":{"type":"integer","format":"int64"},"message":{"type":"string"},"qos-mon":{"type":"boolean"},"state":{"type":"string"},"trace-id":{"type":"string"},"trace-name":{"type":"string"},"traces":{"type":"array","items":{"type":"object","properties":{"action":{"type":"string"},"device-ip":{"type":"string"},"entry_time":{"type":"integer","format":"int64"},"local-system-ip":{"type":"string"},"message":{"type":"string"},"trace-id":{"type":"integer","format":"int32"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/NwpiTraceStopRespPayloadTraces"}}},"description":"Nwpi trace stoppayload schema","$$ref":"#/components/schemas/NwpiTraceStopRespPayload"},"examples":{"Trace stop successfully":{"description":"Trace stop successfully","value":{"action":"success","trace-id":"48","trace-name":"trace_48","state":"stopping","message":"Trace Stop initiated successfully (user stop), ready to notify devices","qos-mon":true,"entry_time":1716782691675,"domain-mon":false,"traces":[{"uuid":"C8K-4efe30b8-f843-4443-bba3-a8b7a5138492","device-ip":"172.16.255.15","local-system-ip":"172.16.255.15","trace-id":48,"entry_time":1716782691675,"action":"success","message":"Device Trace Stop initiated successfully (device is waiting to be notified)"}]}}}}}},"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/stop/{traceId}"}}