uxmEssentials REST

Source-provided project description. FreeMinecraftMods keeps creator credit and adds separate compatibility and decision guidance below.

Project overview

# uxmEssentials REST add-on **HTTP and WebSocket access to uxmEssentials for the programs that are not plugins: a web panel, a Discord bot, a store webhook, a dashboard, a script.** [](https://docs.uxplima.com/minecraft/plugins/uxmessentials/developer/rest-api) [](https://discord.gg/uxplima) [](https://github.com/UXPLIMA/uxmEssentials)   [](https://hangar.papermc.io/UXPLIMA/uxmEssentials-REST)  **Paper 26.2 · Java 25 · Folia-ready · Companion to uxmEssentials · Open source (GPL-3.0)** ## What it does uxmEssentials publishes a developer API that any plugin on the server can compile against. This add-on puts that same reach on a socket, so a program written in anything can use it. - **Read** balances, homes, warps, player-warps, kits, vaults, sanctions and punishment history, playtime, AFK and vanish state, teleport requests, worlds, votes, mail and ignores. - **Write** deposits, withdrawals and transfers; homes and warps; kit grants and claims; bans, mutes, kicks, warns and jails; god, flight, game mode, speed, heal and feed; teleports; world load and unload; votes and party progress; messages and mail. - **Subscribe** to a live event stream over WebSocket, carrying every one of the seventy-four things uxmEssentials announces, so nothing has to be found out by polling. It is built on the published API and nothing else. Every endpoint is one call to a surface a plugin could make itself, which is the rule that keeps the two from drifting apart. ## Tokens, made in game ``` /uxmapi token create [scopes] issue one, shown once /uxmapi token list what exists, without the secrets /uxmapi token revoke stop one working /uxmapi status whether it is listening, and who is connected ``` The secret is printed once, click-to-copy, and never again; what the server keeps is a hash. There is nowhere to paste a secret into a config file, because a secret in a config file ends up in a paste bin, a backup, and a support ticket. Three scopes, granted per token: `read` for every GET, `write` for every POST, `events` for the stream. Both `Authorization: Bearer` and HTTP Basic work. ## Setup 1. Drop `uxmEssentials-rest-0.8.0.jar` into `plugins/` alongside the main uxmEssentials jar and restart. 2. Nothing opens. The add-on writes `plugins/uxmEssentials-rest/config/rest.conf`, says in the log where the switch is, and stays dormant, because a jar that starts listening because it was installed is an incident rather than a feature. ```hocon enabled = false # Where to listen. The default is the loopback address, which is where this belongs. bind = "127.0.0.1" port = 8123 # How many requests one token may make per minute. requests-per-minute = 120 # How many event-stream connections may be open at once, across every token. max-subscribers = 8 ``` 3. Set `enabled = true`, restart, and issue a token with `/uxmapi token create panel`. ```bash curl -H "Authorization: Bearer uxm_..." \ http://127.0.0.1:8123/api/v1/players/$UUID/balance ``` ```json { "ok": true, "data": { "currency": "coins", "amount": 1250.50 } } ``` An operation the server understood and declined is not an HTTP error: it comes back with `ok:false` and the same failure code the Java API returns, so a consumer branches on the same string over HTTP as in process. ## Requirements - **Server:** Paper **26.2** running uxmEssentials **0.8.0**. - **Main jar required** this add-on does nothing on its own. - **No TLS.** The listener speaks plain HTTP and defaults to the loopback address. Put a reverse proxy in front of it if the outside world needs to reach it. ## Notes Open source (GPL-3.0). Full endpoint, body-field and event reference: [docs.uxplima.com](https://docs.uxplima.com/minecraft/plugins/uxmessentials/developer/rest-api/).

FreeMinecraftMods decision guide

This mod is most relevant to players looking for management, technology, utility on folia, paper, purpur. Treat those labels as discovery hints, then verify the exact file and dependency list on the official project page.

The source record was updated on Aug 28, 2026, which is a recent freshness signal. A recent date does not guarantee support for every loader or Minecraft version, so still inspect the current file list.

What to verify before choosing a file

• Confirm that the file is published by the credited creator on the linked official source.
• Match the Minecraft version exactly instead of relying only on a broad category label.
• Read dependencies, incompatibilities, and changelog notes before updating an existing instance.
• Match the loader or server platform and its required version. Forge and NeoForge are not interchangeable.
• Back up worlds and configuration files before testing the project in a long-term save or public server.

Compatibility at a glance

Minecraft versions in this snapshot: 26.1, 26.1.1, 26.1.2, 26.2

Loaders and platforms: folia, paper, purpur

Before you install

Match the exact Minecraft version and loader, install every required dependency, and test in a separate profile before opening an important world. Keep a backup before changing a working mod list.

Source, licensing, and corrections

FreeMinecraftMods does not mirror the project files. Use the official source for downloads, release notes, dependencies, support, and licensing details. Project names, images, and creator-written descriptions remain the property of their respective owners.

How listings are reviewed | Report incorrect project information | Rights-holder and DMCA information