arrow_back All endpoints

Ping Host

POST/api/v1/tools/ping2 credits per callpinglatencynetworkuptimejitterpacket-loss

Probes a public host and reports min/avg/max round-trip time, jitter and packet loss. ICMP is used where the environment permits raw sockets; otherwise a TCP handshake to the given port is timed instead. The response says which method produced the numbers, because the two are not interchangeable. Private, loopback and link-local addresses are refused.

receipt_long
Why 2 credits?

Holds a socket open for a few seconds per run - more than a DNS lookup, far less than a browser.

Any HTTP client works. Replace the key with one from your dashboard.

bash
curl -X POST https://toolkitbackend-j69m.onrender.com/api/v1/tools/ping \
  -H "Authorization: Bearer tb_live_<your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
  "host": "example.com",
  "count": 4,
  "port": 443,
  "timeoutMs": 2000
}'

Input

FieldTypeRequiredDefaultDescription
hoststringrequired- Hostname or IP address. A full URL is accepted and its host is used.
countintegeroptional4 How many probes to send.
portintegeroptional443 TCP port used when ICMP is unavailable. Defaults to 443.
timeoutMsintegeroptional2000 Per-probe timeout in milliseconds.

Output

FieldTypeDescription
resolvedIpstringAddress the host resolved to.
methodstringicmp or tcp - which probe produced these numbers.
sentintegerProbes sent.
receivedintegerProbes answered.
packetLossPercentnumberPercentage of probes with no reply.
minMsnumberFastest round trip.
avgMsnumberMean round trip.
maxMsnumberSlowest round trip.
jitternumberMean deviation between consecutive replies.
attemptsarrayPer-probe sequence, success, latency and status.

Try it

Sends a real POST /api/v1/tools/ping from your browser and charges 2 credits to your account.

Sign in to run this endpoint. New accounts start with free credits.