HytaleAdminAPI Dokumentation
Vollständige REST-API für die Verwaltung und Überwachung von Hytale-Servern
Schnellstart
Teste die API mit einem einfachen Status-Check:
curl -H 'X-Admin-Token: YOUR_TOKEN' http://localhost:5550/api/status
Antwort:
{
"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
}
API Referenz
Status
/api/status
Serverzustand, Ressourcen, Spieler und installierte Mods auf einen Blick
Statistiken
/api/stats
Speicher- und Prozessorwerte der JVM
Version
/api/version
Serverversion, Revision und Protokoll
Spieler
/api/players
Online- und bekannte Spieler, Aktionen und Inventar
Chat
/api/chat
Chatverlauf, Ereignisse und Rundnachrichten
Banns
/api/bans
Spieler bannen und entbannen, auch offline
Stummschaltungen
/api/mutes
Spieler zeitweise oder dauerhaft stummschalten
Welt
/api/world
Zeit und Wetter der ersten geladenen Welt
Warps
/api/warps
Hytales eigene Warps, im Spiel mit /warp nutzbar
Items
/api/items
Item-Katalog mit Suche und Bildern
Bilder
/api/icons
Item-Bilder als PNG
Rechte
/api/permissions
Benutzer, Gruppen und OP in permissions.json
Whitelist
/api/whitelist
Spieler per Name oder UUID freigeben, auch vor dem ersten Besuch
Serverkonfiguration
/api/serverconfig
Hytales config.json lesen und ändern
Backups
/api/backup
Hytales eingebaute Universe-Backups
Tode
/api/deaths
Letzte Spielertode
Erinnerungen
/api/memories
Entdeckte Erinnerungen des Servers
Abenteuer
/api/adventure
Hytale 0.7: Welt-Ereignisse, Portale, Void-Invasionen, Instanzen und Spieler-Werkzeuge
Welten
/api/worlds
Dauerhafte Welten anlegen, laden, auslagern, zurücksetzen und löschen
Spielerwelten
/api/playerworlds
Welten, die Spieler im Spiel mit /meinewelt anlegen
Anleitungen
Architektur & Übersicht
# Architektur & Übersicht **HytaleAdminAPI** (aktuelle Version 1.14.3, gebaut g...
Eranio
Authentifizierung
# Authentifizierung Jede Anfrage braucht den Header `X-Admin-Token` mit dem Tok...
Eranio
Konfiguration
# Konfiguration Der Mod liest `mods/Eranio_HytaleAdminAPI/config.json`. Die Dat...
Eranio
Fehlerbehandlung
# Fehlerbehandlung ## Statuscodes | Code | Wann | |------|------| | `200` | No...
Eranio
Persistenz & Daten
# Persistenz & Daten Der Mod nutzt keine Datenbank. Die Daten liegen in Dateien...
Eranio
Hintergrundprozesse
# Hintergrundprozesse ## Backups `POST /api/backup/create` ruft Hytales eigene...
Eranio
PHP Client Beispiel
# PHP Client Beispiel Ein einfacher PHP-Client für die HytaleAdminAPI. ## Basi...
Eranio