API-Spielwiese
Teste API-Endpunkte direkt im Browser.
Basis-URL
Status /api/status
/api/status
Liefert Online-Zustand, Spielerzahl, Standardwelt, TPS, CPU- und RAM-Auslastung, Laufzeit und die Anzahl installierter Mods.
Antwort
Statistiken /api/stats
/api/stats
Liefert Heap-Nutzung, freien und maximalen Speicher und verfügbare Prozessoren.
Antwort
Version /api/version
/api/version
Liefert Hytale-Serverversion, Build-Revision und Protokollversion.
Antwort
Spieler /api/players
/api/players
Liefert alle Online-Spieler mit Position, Welt, Spielmodus, Leben und Werten sowie die dem Mod bekannten Offline-Spieler.
Antwort
/api/players/known
Schlanke Liste aller Spieler, die schon auf dem Server waren (Name, UUID, zuletzt gesehen).
Antwort
/api/players/{name}
Liefert dieselben Detaildaten wie die Liste für einen Online-Spieler.
Parameter
name
string
*
Antwort
/api/players/{name}/inventory
Liefert Hotbar, Lager, Rüstung, Werkzeugfach, Rucksack und Werkzeuge mit Item-IDs, Mengen und Bildern.
Parameter
name
string
*
Antwort
/api/players/{name}/kick
Trennt einen Online-Spieler mit einer Meldung vom Server.
Parameter
name
string
*
Anfragekörper
reason
string
Antwort
/api/players/{name}/op
Gibt dem Spieler Operator-Rechte.
Parameter
name
string
*
Antwort
/api/players/{name}/deop
Entzieht dem Spieler die Operator-Rechte.
Parameter
name
string
*
Antwort
/api/players/{name}/teleport
Teleportiert den Spieler zu Koordinaten in seiner aktuellen Welt.
Parameter
name
string
*
Anfragekörper
x
number
*
y
number
*
z
number
*
Antwort
/api/players/{name}/give
Legt ein Item ins Inventar, zuerst in die Hotbar.
Parameter
name
string
*
Anfragekörper
item
string
*
amount
integer
Antwort
/api/players/{name}/heal
Füllt das Leben des Spielers voll auf.
Parameter
name
string
*
Antwort
/api/players/{name}/gamemode
Wechselt den Spieler zwischen Abenteuer und Kreativ.
Parameter
name
string
*
Anfragekörper
gamemode
string
*
Antwort
/api/players/{name}/inventory/clear
Leert Hotbar, Lager, Rüstung, Werkzeugfach, Rucksack und Werkzeuge.
Parameter
name
string
*
Antwort
/api/players/{name}/inventory/slot
Legt ein Item auf einen bestimmten Platz und ersetzt den bisherigen Inhalt.
Parameter
name
string
*
Anfragekörper
item
string
*
amount
integer
section
string
slot
integer
Antwort
/api/players/{name}/inventory/slot/remove
Entfernt das Item von einem Platz.
Parameter
name
string
*
Anfragekörper
section
string
slot
integer
Antwort
/api/players/{name}/inventory/slot/swap
Tauscht zwei Plätze, auch zwischen Containern (zum Beispiel Lager und Hotbar).
Parameter
name
string
*
Anfragekörper
fromSection
string
fromSlot
integer
toSection
string
toSlot
integer
Antwort
Chat /api/chat
/api/chat
Liefert die letzten Chatnachrichten oder Einträge eines anderen Ereignis-Logs (zum Beispiel playerJoin, playerLeave, broadcast).
Query-Parameter
limit
integer
eventType
string
Antwort
/api/chat/broadcast
Schickt eine Nachricht an alle Online-Spieler.
Anfragekörper
message
string
*
Antwort
Banns /api/bans
/api/bans
Liefert alle gebannten Spieler mit Grund und Datum.
Antwort
/api/bans
Bannt einen Spieler, online oder offline. Unbekannte Namen werden über den Hytale-Profildienst aufgelöst.
Anfragekörper
player
string
*
reason
string
Antwort
/api/bans/{player}
Hebt einen Bann auf.
Parameter
player
string
*
Antwort
Stummschaltungen /api/mutes
/api/mutes
Liefert alle stummgeschalteten Spieler mit Grund, Moderator und Ende.
Antwort
/api/mutes
Schaltet einen Spieler stumm; er kann nicht mehr im Chat schreiben.
Anfragekörper
player
string
*
reason
string
muted_by
string
duration_minutes
integer
Antwort
/api/mutes/{player}
Hebt eine Stummschaltung auf.
Parameter
player
string
*
Antwort
Welt /api/world
/api/world
Liefert Name, Tageszeit und erzwungenes Wetter der ersten geladenen Welt.
Antwort
/api/world/time
Setzt die Tageszeit.
Anfragekörper
time
string
*
Antwort
/api/world/weather
Liefert das aktuelle Oberflächen-Wetter der Zonen 0 bis 4, die möglichen Wetterarten je Zone, das je Zone festgelegte Wetter und welcher Spieler wo ist.
Parameter
world
string
Antwort
/api/world/weather/zone
Legt das Wetter einer Zone fest oder gibt sie mit natural an die Vorhersage des Spiels zurück.
Anfragekörper
zone
string
*
weather
string
*
world
string
Antwort
/api/world/weather
Erzwingt ein Wetter für die ganze Welt und überdeckt damit alle Zonen. natural hebt es wieder auf.
Anfragekörper
weather
string
*
world
string
Antwort
Warps /api/warps
/api/warps
Liefert alle Warps mit Welt, Position, Blickrichtung und Ersteller, auch im Spiel angelegte.
Antwort
/api/warps
Legt einen Warp an der Position eines Spielers oder an Koordinaten an.
Anfragekörper
name
string
*
player
string
world
string
x
number
y
number
z
number
replace
boolean
creator
string
Antwort
/api/warps/{name}/tp
Teleportiert einen Online-Spieler zum Warp, auch weltübergreifend.
Parameter
name
string
*
Anfragekörper
player
string
*
Antwort
/api/warps/{name}
Entfernt einen Warp.
Parameter
name
string
*
Antwort
Items /api/items
/api/items
Liefert alle Items des laufenden Servers (Hytale 0.7.0: 4008) mit Typ, Name und Bild.
Query-Parameter
q
string
type
string
Antwort
/api/items/search
Wie die Liste, für Suchanfragen gedacht.
Query-Parameter
q
string
type
string
Antwort
Bilder /api/icons
/api/icons/{itemId}/icon
Liefert das Bild eines Items als image/png.
Parameter
itemId
string
*
Antwort
Rechte /api/permissions
/api/permissions
Liefert alle Benutzer mit ihren Gruppen und alle Gruppen mit ihren Rechten.
Antwort
/api/permissions/groups
Liefert nur die Gruppen.
Antwort
/api/permissions/op
Gibt einem Spieler per UUID Operator-Rechte.
Anfragekörper
uuid
string
*
Antwort
/api/permissions/op/{uuid}
Entzieht die Operator-Rechte.
Parameter
uuid
string
*
Antwort
/api/permissions/user/group
Nimmt einen Spieler in eine Gruppe auf.
Anfragekörper
uuid
string
*
group
string
*
Antwort
/api/permissions/user/group
Nimmt einen Spieler aus einer Gruppe heraus.
Anfragekörper
uuid
string
*
group
string
*
Antwort
/api/permissions/groups
Legt eine Rechtegruppe an.
Anfragekörper
name
string
*
permissions
array
Antwort
/api/permissions/groups/{name}
Löscht eine Rechtegruppe.
Parameter
name
string
*
Antwort
Whitelist /api/whitelist
/api/whitelist
Liefert, ob die Whitelist aktiv ist, und alle Einträge.
Antwort
/api/whitelist
Trägt einen Spieler ein. Unbekannte Namen löst Hytales whitelist-Befehl auf; Erfolg nur bei Bestätigung durch Hytale.
Anfragekörper
name
string
uuid
string
Antwort
/api/whitelist/{name}
Entfernt einen Spieler von der Whitelist.
Parameter
name
string
*
Antwort
Serverkonfiguration /api/serverconfig
/api/serverconfig
Liefert die vollständige config.json des Servers.
Antwort
/api/serverconfig
Ändert einen oder mehrere Schlüssel der config.json. Die meisten Änderungen brauchen einen Neustart.
Anfragekörper
<key>
any
Antwort
/api/serverconfig/reload
Liest config.json erneut von der Platte.
Antwort
Backups /api/backup
/api/backup
Liefert alle Backup-Zips mit Größe und Datum.
Antwort
/api/backup/config
Liefert Hytales Backup-Konfiguration (Ordner, Intervall, Aufbewahrung).
Antwort
/api/backup/status
Zeigt, ob ein Backup läuft, und das Ergebnis des letzten.
Antwort
/api/backup/create
Startet ein Backup des Universe mit Hytales eigener Backup-Funktion.
Antwort
/api/backup
Löscht eine Backup-Datei.
Anfragekörper
filename
string
*
Antwort
Tode /api/deaths
/api/deaths
Liefert die letzten 10 Tode mit Zeit, Spieler und Ursache sowie die Gesamtzahl.
Antwort
Erinnerungen /api/memories
/api/memories
Liefert alle Erinnerungs-Kategorien und Einträge mit Entdeckt-Status und übersetzten Namen. Erinnerungen gelten serverweit.
Antwort
Abenteuer /api/adventure
/api/adventure
Liefert jede geladene Welt (dauerhaft oder Instanz) mit Welt-Ereignissen, Spawn, Portal-Zustand, Stufen der Void-Invasion und Spielern mit Größe, Teleport-Verlauf, Wildnis-Karte und Debug-Sperre; dazu die Instanz-Vorlagen.
Antwort
/api/adventure/world-events
Schaltet Hytales Welt-Ereignisse (zum Beispiel Goblin-Einbrüche) für eine Welt an oder aus.
Anfragekörper
world
string
enabled
boolean
*
Antwort
/api/adventure/portal/time
Ändert die Restzeit einer Portal-Welt, zwischen 10 Sekunden und 6 Stunden.
Anfragekörper
world
string
seconds
integer
*
mode
string
Antwort
/api/adventure/portal/timer
Schaltet das Zeitlimit einer Portal-Welt um.
Anfragekörper
world
string
Antwort
/api/adventure/portal/void
stop entfernt die Invasion und hält ihren Zähler an, die Portalzeit läuft weiter; allow setzt den Plan zurück.
Anfragekörper
world
string
action
string
*
Antwort
/api/adventure/debug-screens
Sperrt oder erlaubt die Debug-Anzeige (F3) für einen Spieler.
Anfragekörper
player
string
*
blocked
boolean
*
Antwort
/api/adventure/teleport-player
Teleportiert einen Spieler zu einem anderen, auch weltübergreifend.
Anfragekörper
player
string
*
target
string
*
Antwort
/api/adventure/spawn
Setzt den Spawnpunkt einer Welt an der Position eines Spielers oder an Koordinaten.
Anfragekörper
player
string
world
string
x
number
y
number
z
number
Antwort
/api/adventure/send-to-spawn
Schickt einen Spieler zum Spawn einer Welt.
Anfragekörper
player
string
*
world
string
Antwort
/api/adventure/scale
Skaliert einen Spieler zwischen 25 und 400 %.
Anfragekörper
player
string
*
scale
number
*
Antwort
/api/adventure/history
Bewegt einen Spieler im Teleport-Verlauf einen Schritt zurück oder vor (wie /back).
Anfragekörper
player
string
*
direction
string
Antwort
/api/adventure/wilderness
Zeigt oder versteckt die Wildnis-Debug-Karte für einen Spieler.
Anfragekörper
player
string
*
enabled
boolean
*
Antwort
/api/adventure/instance/spawn
Öffnet eine neue Instanz aus einer Vorlage und schickt den Spieler hinein. Beim Verlassen kehrt er an die alte Position zurück.
Anfragekörper
template
string
*
player
string
*
Antwort
/api/adventure/instance/exit
Holt einen Spieler aus einer Instanz zurück in die vorherige Welt.
Anfragekörper
player
string
*
Antwort
/api/adventure/instance/close
Schließt eine leere Instanz.
Anfragekörper
world
string
*
Antwort
Welten /api/worlds
/api/worlds
Liefert geladene Welten (Standardwelt zuerst) mit Art, Besitzer, Einstellungen und Größe sowie entladene, ausgelagerte und gelöschte Welten und die verfügbaren Generatoren.
Antwort
/api/worlds/create
Legt eine dauerhafte Welt an. Hytale lädt sie bei jedem Start.
Anfragekörper
name
string
*
generator
string
kind
string
owner
string
display_name
string
game_mode
string
pvp
boolean
fall_damage
boolean
npc_spawning
boolean
npc_frozen
boolean
time_paused
boolean
Antwort
/api/worlds/load
Lädt eine entladene Welt.
Anfragekörper
name
string
*
Antwort
/api/worlds/unload
Speichert und entlädt eine Welt; der Ordner bleibt.
Anfragekörper
name
string
*
Antwort
/api/worlds/delete
Verschiebt eine Welt in den Papierkorb; gelöscht wird noch nichts.
Anfragekörper
name
string
*
Antwort
/api/worlds/restore
Holt eine Welt aus dem Papierkorb zurück und lädt sie.
Anfragekörper
folder
string
*
Antwort
/api/worlds/purge
Löscht einen Papierkorb-Eintrag von der Platte.
Anfragekörper
folder
string
*
Antwort
/api/worlds/park
Entlädt eine Welt und verschiebt sie nach universe/worlds-parked, damit Hytale sie beim Start nicht lädt.
Anfragekörper
name
string
*
Antwort
/api/worlds/unpark
Legt eine ausgelagerte Welt zurück und lädt sie.
Anfragekörper
name
string
*
load
boolean
Antwort
/api/worlds/mark
Markiert eine Welt als Server- oder Spielerwelt mit Besitzer (für das Panel).
Anfragekörper
name
string
*
kind
string
owner
string
Antwort
/api/worlds/default
Macht eine Welt zur Standardwelt des Servers.
Anfragekörper
name
string
*
Antwort
/api/worlds/settings
Ändert Einstellungen einer geladenen Welt; nur die übergebenen Felder ändern sich.
Anfragekörper
name
string
*
display_name
string
game_mode
string
pvp
boolean
fall_damage
boolean
npc_spawning
boolean
npc_frozen
boolean
time_paused
boolean
Antwort
/api/worlds/reset
Löscht eine Welt und erzeugt sie mit neuem Seed neu (Farmwelt). Generator, Einstellungen und Anzeigename bleiben.
Anfragekörper
name
string
*
move_warps
boolean
Antwort
/api/worlds/send
Teleportiert einen Spieler zum Spawn einer anderen Welt.
Anfragekörper
player
string
*
world
string
*
Antwort
Spielerwelten /api/playerworlds
/api/playerworlds
Liefert die Einstellungen und jede Spielerwelt mit Anzeigename, Besitzer, Mitgliedern, Gästen, Lade- und Freischalt-Zustand.
Antwort
/api/playerworlds/config
Ändert die globalen Einstellungen der Spielerwelten.
Anfragekörper
creation_enabled
boolean
max_per_player
integer
idle_park_minutes
integer
Antwort