FAQ

Does a public site need a token?

No. Visitors read the paths in auth.anonymous.endpoints, and they never see coordinates, inventories, IP addresses, or chat unless you turn that on in privacy.anonymous. See Configuration.

Why port 8110?

BlueMap's web server uses 8100. Change http.port if 8110 is taken.

The console warns about HTTP exposure. What now?

A request reached WorldAPI from the internet without HTTPS. Put a proxy in front of it: Reverse proxy.

I lost my panel password

Run /worldapi admin in game for a code that sets a new one, or ask another admin for a reset code from the Accounts page.

Why do item icons answer 503 at first?

WorldAPI downloads the game client from Mojang once to read its textures. Until it has it, GET /icons/{key} answers 503 icons_loading with Retry-After. Set panel.icons: false to skip it.

A leaderboard leaves out an online player

A vanished player looks offline to every client without players:moderate. That's on purpose.

My config change didn't apply

/worldapi reload applies config.yml, except database, which needs a restart. A misspelled key fails the reload, and the console says which one.

Configs you change through /files belong to the server and other plugins: they read them at start or on their own reload command.

Does restarting through the API bring the server back?

POST /server/restart counts down in chat, saves, and stops the server. Something must start it again: Docker's restart policy, or a start script that loops.

Does WorldAPI see history from before I installed it?

No. It records events from the moment it's installed; older joins and deaths stay in the server logs. Statistics and advancements come from the game's own files, so they cover everything.

What can't WorldAPI do?

WorldAPI uses no NMS, so a few things stay out of reach:

• Offline players' inventories, ender chests, health, and effects can't change. Paper exposes them only for online players, so WorldAPI answers 409 player_offline. It still reads an offline player's inventory and ender chest from their playerdata file, and statistics, advancements, and XpTotal from the vanilla files.
• Raw NBT of block entities. WorldAPI shows what Paper models: container contents, sign text, spawner type, skull owner, jukebox record. Items come with their full component string, such as minecraft:diamond_sword[enchantments={sharpness:5}].
• Particles with extra data (dust colors, block particles) aren't supported yet; plain particles are.