A Hytale server mod that exposes a REST API over HTTP so you can manage players, run server commands, and monitor your server from external tools, dashboards, or scripts.
/api/deaths, /api/deaths/summary, /api/deaths/recent/api/mods and /api/mods/configsapiKey in config.json.http://localhost:8223/api/health.All endpoints except /api/health require the header: X-API-Key: <your-api-key>.
I created this mod because I've been playing with friends hosting a server, and I wanted to have a place to centralize general info and useful tools. It started as a side-project but I have used it so much for my boards and other mods, I decided to make it available here as it may suit some of you.
I believe its easier to show it's potential through some stuff I built:
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/health |
Check API status (no auth) |
| GET | /api/server/status |
Server information |
| GET | /api/deaths |
Death counter: summary, recent deaths, total (built-in tracking) |
| GET | /api/deaths/summary |
Per-player death counts (sorted by deaths) |
| GET | /api/deaths/recent |
Recent deaths (optional ?limit=50) |
| GET | /api/mods |
List installed mods (JAR and ZIP in mods folder) |
| GET | /api/mods/configs |
List mod config folders, config files, and main class when resolvable from manifest (mods/<folder>/manifest.json or mods/<folder>.jar) |
| GET | /api/universe/players |
List saved players from Server/universe/players/*.json (id, name) for the board app |
| GET | /api/universe/players/{id} |
Full player JSON by id (filename without .json) |
| GET | /api/players |
List online players |
| GET | /api/players/{name} |
Get specific player info |
| POST | /api/players/{name}/give |
Give item to player |
| POST | /api/players/{name}/kick |
Kick player |
| POST | /api/players/{name}/ban |
Ban player |
| POST | /api/players/{name}/unban |
Unban player |
| POST | /api/broadcast |
Send message to all players |
| POST | /api/command |
Execute server command |
Edit mods/ArisuRESTAPI/config.json:
| Option | Default | Description |
|---|---|---|
port |
8223 | HTTP port |
apiKey |
changeme | needed for authentication |
bindAddress |
0.0.0.0 | Bind address (0.0.0.0 = all) |
There are plenty of uses to manipulate your server with these commands from web if you wish to do so. Use and modify as needed for your server!
Make chests bound to the player who placed them; only the owner/whitelisted players can open a bound chest. Workbenches only use materials from chests allowed by the interacting player.
Make chests bound to the player who placed them; only the owner/whitelisted players can open a bound chest. Workbenches only use materials from chests allowed by the interacting player.