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

1. Place HyRESTAPI-x.x.x.jar in your server's mods folder
2. Start your server to generate the default configuration.
3. 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"}'