API Playground

Returns online state, player count, default world, TPS, CPU and RAM usage, uptime and the number of installed mods.

Returns heap usage, free and maximum memory and available processors.

Returns the Hytale server version, build revision and protocol version.

Returns all online players with position, world, game mode, health and stats, plus offline players known to the mod.

Lightweight list of every player that has been on the server (name, UUID, last seen).

Returns the same detailed data as the list for one online player.

Returns hotbar, storage, armor, utility, backpack and tools with item IDs, amounts and icons.

Disconnects an online player with a message.

Gives the player operator rights.

Removes operator rights from the player.

Teleports the player to coordinates in their current world.

Adds an item to the inventory, hotbar first.

Restores the player to full health.

Switches the player between Adventure and Creative.

Empties hotbar, storage, armor, utility, backpack and tools.

Places an item into a specific slot and replaces what was there.

Removes the item from one slot.

Swaps two slots, also between containers (for example storage and hotbar).

Returns the latest chat messages or entries of another event log (for example playerJoin, playerLeave, broadcast).

Sends a message to all online players.

Returns all banned players with reason and date.

Bans a player, online or offline. Unknown names are resolved through the Hytale profile service.

Removes a ban.

Returns all muted players with reason, moderator and end time.

Mutes a player; muted players cannot write in chat.

Removes a mute.

Returns name, time of day and forced weather of the first loaded world.

Sets the time of day.

Returns the current surface weather of zones 0 to 4, the weathers each zone can have, the weather fixed per zone and which players are where.

Fixes the weather of one zone or gives it back to the game forecast with natural.

Forces one weather for the whole world, overriding every zone. natural lifts it again.

Returns all warps with world, position, rotation and creator, including warps created in game.

Creates a warp at a player's position or at coordinates.

Teleports an online player to the warp, also across worlds.

Removes a warp.

Returns every item of the running server (Hytale 0.7.0: 4008) with type, name and icon.

Same as the list, meant for search requests.

Returns the icon of an item as image/png.

Returns all users with their groups and all groups with their permission nodes.

Returns only the groups.

Gives a player operator rights by UUID.

Removes operator rights.

Puts a player into a group.

Takes a player out of a group.

Creates a permission group.

Deletes a permission group.

Returns whether the whitelist is enabled and all entries.

Adds a player. Unknown names are resolved through Hytale's whitelist command; success is only reported when Hytale confirms.

Removes a player from the whitelist.

Returns the complete config.json of the server.

Updates one or more keys of config.json. Most changes need a restart.

Reads config.json from disk again.

Returns all backup zip files with size and date.

Returns Hytale's backup configuration (folder, interval, retention).

Shows whether a backup is running and the result of the last one.

Starts a backup of the universe with Hytale's own backup function.

Deletes one backup file.

Returns the last 10 deaths with time, player and cause, plus the total count.

Returns all memory categories and entries with discovery state and translated names. Memories are server-wide.

Returns every loaded world (permanent or instance) with world events, spawn, portal state, void invasion stages and players with size, teleport history, wilderness map and debug lock; also the instance templates.

Turns Hytale's world events (for example goblin raids) on or off for one world.

Changes the remaining time of a portal world, between 10 seconds and 6 hours.

Toggles the time limit of a portal world.

stop removes the invasion and holds its counter while the portal time keeps running; allow resets the plan.

Locks or unlocks the debug screen (F3) for a player.

Teleports a player to another player, also across worlds.

Sets the spawn point of a world at a player's position or at coordinates.

Sends a player to the spawn of a world.

Scales a player between 25 and 400 %.

Moves a player one step back or forward in the teleport history (like /back).

Shows or hides the wilderness debug map for a player.

Opens a new instance from a template and sends the player in. On leaving the player returns to the old position.

Brings a player out of an instance back to the previous world.

Closes an empty instance.

Returns loaded worlds (default first) with type, owner, settings and size, plus unloaded, parked and trashed worlds and the available generators.

Creates a permanent world. Hytale loads it on every start.

Loads an unloaded world.

Saves and unloads a world; the folder stays.

Moves a world to the trash; nothing is deleted yet.

Moves a world back from the trash and loads it.

Deletes a trash entry from disk.

Unloads a world and moves it to universe/worlds-parked, so Hytale does not load it on start.

Moves a parked world back and loads it.

Marks a world as server world or player world with owner (for the panel).

Makes a world the default world of the server.

Changes settings of a loaded world; only the given fields change.

Deletes a world and generates it again with a new seed (farm world). Generator, settings and display name stay.

Teleports a player to the spawn of another world.

Returns the settings and every player world with display name, owner, members, guests, loaded and unlocked state.

Changes the global settings for player worlds.