v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Gateways

Initiate a Ping test on a Gateway

Starts an asynchronous Ping test on the specified Gateway.

post/network-troubleshooting/v1/gateways/{serial-number}/ping

serial-numberstring required

Serial number of the target device

destinationstring required

Hostname/IP address required

packetSizeinteger

The packet size in bytes (10-2000)

countinteger

Number of probes to send (1-100)

ttlinteger

Time To Live for IP datagram (1-255)

dscpinteger

DSCP packet header value between 0 and 63

dontFragmentFlagboolean

Don't Fragment Flag

sourceInterface'loopback' | 'mgmt-interface' | 'vlan-interface'

vlannumber

useIpv6boolean

Use IPv6

includeRawOutputboolean

Whether to include raw output in the response.

Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status.

locationstring uri-reference

The relative URL path to query the status and result of the asynchronous operation.

status'INITIATED'

The initial status of the operation.

startTimestring date-time

ISO 8601 timestamp indicating when the operation was initiated.