{"type":"api","title":"Ping Device","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 - Device Connectivity"],"description":"Ping device","operationId":"pingDevice","parameters":[{"name":"deviceIP","in":"path","description":"Device IP","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Ping parameter","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"string","example":"5"},"host":{"type":"string","example":"10.1.12.16"},"rapid":{"type":"string","example":"true"},"size":{"type":"string","example":"128"},"source":{"type":"string","example":"10.1.12.15"},"vpn":{"type":"string","example":"0"}},"$$ref":"#/components/schemas/PingRequest"},"examples":{"Ping parameter":{"description":"Ping parameter","value":{"host":"10.1.12.16","source":"10.1.12.15","vpn":"0"}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"avgRoundTrip":{"type":"number","example":0.389},"lossPercentage":{"type":"number","example":0},"maxRoundTrip":{"type":"number","example":0.534},"minRoundTrip":{"type":"number","example":0.226},"packetsReceived":{"type":"number","example":5},"packetsTransmitted":{"type":"number","example":5},"rawOutput":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/PingResponse"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Tools-read","method":"post","path":"/device/tools/ping/{deviceIP}"}}