API Playground
Test API endpoints directly in your browser.
Base URL
Status /api/status
/api/status
Returns the current server status including player count, TPS and uptime.
Response
Statistics /api/stats
/api/stats
Detailed server performance data and metrics.
Response
Version /api/version
/api/version
Returns the API version and server version.
Response
Players /api/players
/api/players
List of all currently online players with details.
Response
/api/players/{name}
Detailed information about a specific player.
Parameters
name
string
*
Response
/api/players/{name}/kick
Removes a player from the server.
Parameters
name
string
*
Request Body
reason
string
Response
/api/players/{name}/teleport
Teleports a player to specific coordinates.
Parameters
name
string
*
Request Body
x
number
*
y
number
*
z
number
*
world
string
Response
/api/players/{name}/gamemode
Changes the game mode of a player.
Parameters
name
string
*
Request Body
mode
string
*
Response
Chat /api/chat
/api/chat/send
Sends a message to all players in chat.
Request Body
message
string
*
sender
string
Response
/api/chat/send/{player}
Sends a private message to a specific player.
Parameters
player
string
*
Request Body
message
string
*
Response
Bans /api/bans
/api/bans
List of all banned players.
Response
/api/bans/add
Bans a player from the server.
Request Body
player
string
*
reason
string
duration
string
Response
/api/bans/{player}
Removes a player's ban.
Parameters
player
string
*
Response
Mutes /api/mutes
/api/mutes
List of all muted players.
Response
/api/mutes/add
Mutes a player.
Request Body
player
string
*
reason
string
duration
string
Response
/api/mutes/{player}
Removes a player's mute.
Parameters
player
string
*
Response
World /api/world
/api/world
General information about the current world.
Response
/api/world/time
Sets the time of day for the world.
Request Body
time
integer
*
Response
/api/world/weather
Changes the weather of the world.
Request Body
weather
string
*
Response
/api/world/save
Saves the current world to disk.
Response
Warps /api/warps
/api/warps
List of all saved warp points.
Response
/api/warps/create
Creates a new warp point.
Request Body
name
string
*
x
number
*
y
number
*
z
number
*
world
string
Response
/api/warps/{name}
Deletes a warp point.
Parameters
name
string
*
Response
/api/warps/{name}/teleport/{player}
Teleports a player to a warp point.
Parameters
name
string
*
player
string
*
Response
Items /api/items
/api/items/{player}
Shows a player's inventory.
Parameters
player
string
*
Response
/api/items/{player}/give
Gives a player an item.
Parameters
player
string
*
Request Body
item
string
*
amount
integer
Response
/api/items/{player}/clear
Clears a player's inventory.
Parameters
player
string
*
Response
Icons /api/icons
/api/icons/motd
Returns the current MOTD (Message of the Day).
Response
/api/icons/motd
Sets a new MOTD.
Request Body
motd
string
*
Response
Permissions /api/permissions
/api/permissions/{player}
Shows all permissions of a player.
Parameters
player
string
*
Response
/api/permissions/{player}/add
Adds a permission to a player.
Parameters
player
string
*
Request Body
permission
string
*
Response
/api/permissions/{player}/{permission}
Removes a permission from a player.
Parameters
player
string
*
permission
string
*
Response
Whitelist /api/whitelist
/api/whitelist
List of all whitelisted players.
Response
/api/whitelist/add
Adds a player to the whitelist.
Request Body
player
string
*
Response
/api/whitelist/{player}
Removes a player from the whitelist.
Parameters
player
string
*
Response
/api/whitelist/toggle
Enables or disables the whitelist.
Request Body
enabled
boolean
*
Response
Server Config /api/config
/api/config
Returns the current server configuration.
Response
/api/config/set
Changes configuration values. Some changes require a restart.
Request Body
key
string
*
value
mixed
*
Response
Backup /api/backup
/api/backup/list
List of all available backups.
Response
/api/backup/create
Starts creating a new backup (asynchronous).
Response
/api/backup/status
Status of the currently running backup.
Response
/api/backup/{name}
Deletes a specific backup.
Parameters
name
string
*
Response
Deaths /api/deaths
/api/deaths
List of all recorded deaths.
Response
/api/deaths/{player}
Deaths of a specific player.
Parameters
player
string
*
Response
/api/deaths/stats
Analysis of the most common causes of death.
Response
Memories /api/memories
/api/memories
List of all stored memories.
Response
/api/memories/create
Creates a new memory.
Request Body
title
string
*
content
string
*
tags
array
Response
/api/memories/{id}
Deletes a memory by its ID.
Parameters
id
integer
*
Response