Endpoints
GET /api/example.net
GET /api/example.net:25565
GET /api/v1/example.net
GET /api/ping?address=example.net
GET /api/v1/ping?host=example.net:25565
GET /example.net?json=true
Online response
{
"blocked": false,
"data": {
"version": { "name": "1.21.11", "protocol": 774 },
"players": { "max": 100, "online": 12, "sample": [] },
"description": { "text": "A Minecraft Server" },
"favicon": "data:image/png;base64,...",
"enforcesSecureChat": false
},
"dns": [
{
"data": "10 10 25565 backend.example.net",
"hostname": "example.net",
"type": "srv"
},
{
"data": "203.0.113.10",
"hostname": "backend.example.net",
"type": "a"
}
],
"ok": true,
"ping": 24,
"rateLimit": {
"limit": 1,
"window": 60,
"remaining": 0,
"cached": false,
"retryAfter": 60
}
}
Offline response
{
"blocked": false,
"error": "no_response",
"error_message": "Server did not respond.",
"ok": false,
"rateLimit": {
"limit": 1,
"window": 60,
"remaining": 0,
"cached": false,
"retryAfter": 60
}
}
Blocked response
{
"blocked": true,
"error": "blocked",
"error_message": "Private or unresolved addresses cannot be pinged",
"ok": false,
"rateLimit": {
"limit": 1,
"window": 60,
"remaining": 0,
"cached": false,
"retryAfter": 60
}
}