HyRESTAPI
HyRESTAPI is a Hytale server mod that provides a REST API for managing players, executing server commands and monitoring server status through http endpoint.
About HyRESTAPI
HyRESTAPI is a Hytale server mod that provides a REST API for managing players, executing server commands and monitoring server status through http endpoint.
HyRESTAPI Installation
Place HyRESTAPI-x.x.x.jar in your server's mods folder
Start your server to generate the default configuration.
Test if API is ready at http://localhost:8080/api/health
Endpoints
GET /api/health - Check API status
GET /api/server/status - Get server information
GET /api/players - List all 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
Example Usage
Giving Item (Gives Flame Longsword to a player)
Change <name> to your username.
curl -X POST http://localhost:8080/api/players/<name>/give \ -H "X-API-Key: changeme" \ -H "Content-Type: application/json" \ -d '{"item": "Weapon_Longsword_Flame", "amount": 1}' Broadcasting Server Message
curl -X POST http://localhost:8080/api/broadcast \ -H "X-API-Key: changeme" \ -H "Content-Type: application/json" \ -d '{"message": "hello world"}'
Categories
Need a Server?
Run HyRESTAPI on a dedicated Hytale server with easy mod management.
Get Hytale HostingFrequently Asked Questions
What is HyRESTAPI?
HyRESTAPI is a Hytale server mod that provides a REST API for managing players, executing server commands and monitoring server status through http endpoint.
How do I download HyRESTAPI?
You can download HyRESTAPI for free from CurseForge. Click the "Download on CurseForge" button on this page to go directly to the download page.
Who created HyRESTAPI?
HyRESTAPI was created by Kozejin. The mod has been downloaded 75 times.
Is HyRESTAPI compatible with Hytale servers?
HyRESTAPI is designed for Hytale and can be used on both single-player and multiplayer servers. Check the mod page on CurseForge for specific compatibility information.
How do I install HyRESTAPI?
To install HyRESTAPI: 1) Download the mod from CurseForge, 2) Place the file in your Hytale mods folder, 3) Restart the game. The mod should load automatically.
Related Utility Mods
View all mods
BetterMap
Paralaxe
Enhance Hytale World Map
Hybrid
Serilum
🏛️ A Hytale mod library that contains common code for all of Serilum's mods.
VeinMining
EineNT
Instantly mine connected ores and blocks by holding the Walk key (LEFT ALT) while breaking a single block.
Wayback Charm
DarkhaxDev
A charm to help you find your way back home.
Better Modlist
Buuz135
Adds a better modlist to the game, with improved features like searching and logos.
Simple Claims
Buuz135
Adds a chunk claim and protection system.