Status

Base: /api/status

Server state, resources, players and installed mods at a glance

Handler: StatusHandler

GET /api/status

Get server status

Returns online state, player count, default world, TPS, CPU and RAM usage, uptime and the number of installed mods.

Response Example

{
  "online": true,
  "online_players": 3,
  "default_world": "default",
  "world_count": 2,
  "server_name": "Hytale Server",
  "max_players": 100,
  "version": "0.7.0",
  "cpu_system": 11,
  "cpu_process": 4,
  "ram_total_mb": 16384,
  "ram_free_mb": 9120,
  "ram_used_mb": 7264,
  "heap_used_mb": 1444,
  "heap_max_mb": 8192,
  "heap_percent": 17,
  "jvm_uptime": "2h 15m",
  "jvm_uptime_ms": 8100000,
  "uptime": "2h 14m",
  "uptime_ms": 8040000,
  "tps": 30.0,
  "installed_mods_count": 2
}

cURL

curl -X GET 'http://localhost:5550/api/status' \
  -H 'X-Admin-Token: YOUR_TOKEN'

Internal Behavior

Reads the universe, the server config and the JVM management beans. No world thread is needed.