HytaleAdminAPI Documentation

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

{
  "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
}

1 Endpoint

Status

/api/status

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

1 Endpoint

Statistics

/api/stats

JVM memory and processor figures

1 Endpoint

Version

/api/version

Server version, revision and protocol

15 Endpoints

Players

/api/players

Online and known players, actions and inventory

2 Endpoints

Chat

/api/chat

Chat history, events and broadcasts

3 Endpoints

Bans

/api/bans

Ban and unban players, also offline

3 Endpoints

Mutes

/api/mutes

Mute players for a time or permanently

5 Endpoints

World

/api/world

Time, forced weather and weather per zone

4 Endpoints

Warps

/api/warps

Hytale's own warps, usable in game with /warp

2 Endpoints

Items

/api/items

Item catalogue with search and icons

1 Endpoint

Icons

/api/icons

Item icons as PNG

8 Endpoints

Permissions

/api/permissions

Users, groups and OP in permissions.json

3 Endpoints

Whitelist

/api/whitelist

Allow players by name or UUID, also before their first visit

3 Endpoints

Server config

/api/serverconfig

Read and change Hytale's config.json

5 Endpoints

Backups

/api/backup

Hytale's built-in universe backups

1 Endpoint

Deaths

/api/deaths

Latest player deaths

1 Endpoint

Memories

/api/memories

Discovered memories of the server

15 Endpoints

Adventure

/api/adventure

Hytale 0.7: world events, portals, void invasions, instances and player tools

14 Endpoints

Worlds

/api/worlds

Create, load, park, reset and delete permanent worlds

2 Endpoints

Player worlds

/api/playerworlds

Worlds that players create in game with /myworld