Ping a remote server

POST 
/network/ping

Send a ping to a remote server to verify network connectivity.

Request

application/json

Body

required

The server to ping.

address stringrequired

The IP address of the server to ping. Supports both IPv4 and IPv6.

Responses

200

Successful ping response.

application/json

Schema

Schema

packets_sent integer

Number of packets sent.

packets_received integer

Number of packets received.

packet_loss double

Percentage of packet loss.

min_rtt string

Minimum round-trip time as a string in Go's time.Duration format.

avg_rtt string

Average round-trip time as a string in Go's time.Duration format.

max_rtt string

Maximum round-trip time as a string in Go's time.Duration format.

Example (from schema)

{
  "packets_sent": 4,
  "packets_received": 4,
  "packet_loss": 0,
  "min_rtt": "14.637103ms",
  "avg_rtt": "18.647498ms",
  "max_rtt": "24.309240ms"
}

400

Invalid request payload.

application/json

Schema

Schema

error stringrequired

A description of the error that occurred.

details string

Additional details about the error, specifying which component failed.

code integerrequired

The error code.

Example (from schema)

{
  "error": "Failed to retrieve network status.",
  "details": "Failed to get DNS servers due to network timeout.",
  "code": 500
}

500

Error performing the ping operation.

application/json

Schema

Schema

error stringrequired

A description of the error that occurred.

details string

Additional details about the error, specifying which component failed.

code integerrequired

The error code.

Example (from schema)

{
  "error": "Failed to retrieve network status.",
  "details": "Failed to get DNS servers due to network timeout.",
  "code": 500
}

Loading...