# NoxAeApi by NoxlyDev & Wumx Labs > A high-performance REST and WebSocket API plugin/mod for Minecraft servers (Paper, Spigot, Bukkit, Fabric) created by NoxlyDev and Wumx Labs. Official TypeScript SDK: `@wumx-labs/noxaeapi-sdk` (zero runtime dependencies, typed error hierarchy, WebSocket auto-reconnect). Authentication is via a `key` header configured by the server operator. The default port is 8080 (e.g. `http://your-server:8080`). ## Documentation - [Getting Started](/docs/getting-started): Install and make your first request - [NPM SDK Module](/docs/npm-module): Official @wumx-labs/noxaeapi-sdk TypeScript package documentation - [Authentication](/docs/authentication): API key configuration and usage - [Examples](/docs/examples): Common tasks in curl, JavaScript, TypeScript, and Python - [Errors](/docs/errors): Status codes and error handling - [API Reference](/reference): Complete REST endpoints and parameters ## Endpoints ### Server Server info, administration, whitelist, ops, scoreboard, and console. - `GET /v1/server` — Server info: Returns server metadata: name, motd, version, TPS, health, bans, whitelist, and player counts. - `POST /v1/server/restart` (admin) — Restart the server: Restarts the Minecraft server process. All players are disconnected. - `POST /v1/server/ban-ip` (admin) — Ban an IP address: Adds an IP address to the server ban list. - `POST /v1/server/exec` (admin) — Run a console command: Executes an arbitrary console command. High-privilege — never call with untrusted input. - `GET /v1/server/logs` — Recent log lines: Returns the last N lines of the server log. - `GET /v1/server/whitelist` — List whitelist: Returns all whitelisted players. - `POST /v1/server/whitelist` (admin) — Add to whitelist: Adds a player to the whitelist. - `DELETE /v1/server/whitelist` (admin) — Remove from whitelist: Removes a player from the whitelist by uuid or name. - `GET /v1/ping` — Health check: Simple liveness check. Returns "pong!". - `GET /v1/scoreboard` — Scoreboard: Returns all scoreboard objectives and entries. ### Player Manage online and offline players: bans, kicks, gamemode, teleport, and stats. - `GET /v1/players` — Online players: Returns all currently online players. - `GET /v1/players/all` — All players: Returns every player that has ever joined. Paginated. - `GET /v1/players/{uuid}` — Get one player: Returns a single online player by UUID. - `POST /v1/players/{uuid}/ban` (admin) — Ban a player: Bans a player by UUID. - `POST /v1/players/{uuid}/kick` (admin) — Kick a player: Kicks an online player. - `PUT /v1/players/{uuid}/gamemode` (admin) — Change gamemode: Changes a player gamemode. - `POST /v1/players/{uuid}/teleport` — Teleport a player: Teleports a player to coordinates in a world. - `GET /v1/players/{uuid}/stats` — Player statistics: Returns player statistics (works for online and offline players). ### Chat Broadcast messages and whisper to individual players. - `POST /v1/chat/broadcast` — Broadcast a message: Sends a message to all online players. - `POST /v1/chat/tell` — Whisper to a player: Sends a private message to a single player. ### Economy Player balances and transactions via a Vault-compatible economy plugin. - `GET /v1/economy/balance/{uuid}` — Get balance: Returns the balance for a player. - `POST /v1/economy/pay` — Deposit funds: Deposits an amount into a player balance. - `POST /v1/economy/debit` (admin) — Withdraw funds: Withdraws an amount from a player balance. - `GET /v1/economy/top` — Balance leaderboard: Returns the top balance leaderboard. ### LuckPerms Groups and permission nodes for players and groups. - `GET /v1/luckperms/groups` — List groups: Returns all LuckPerms groups. - `POST /v1/luckperms/groups` (admin) — Create group: Creates a new group. - `GET /v1/luckperms/player/{uuid}/permissions` — Player permissions: Returns a player permission nodes. - `POST /v1/luckperms/player/{uuid}/check-permission` — Check permission: Checks a resolved permission including inheritance and wildcards. ### Skills Read player skill levels from supported RPG plugins. - `GET /v1/skills/mcmmo/player/{uuid}` — mcMMO levels: Returns mcMMO skill levels (online players only). - `GET /v1/skills/auraskills/player/{uuid}` — AuraSkills levels: Returns AuraSkills skill levels (works offline). ### NoxAuth Authentication info and password checks. Uses player name, not UUID. - `GET /v1/noxauth/player/{name}` — Auth info: Returns registration, authentication, last login, and country info. - `POST /v1/noxauth/player/{name}/check-password` (admin) — Check password: Checks a password against the stored hash. ### PlaceholderAPI Resolve PlaceholderAPI placeholders in a string. - `POST /v1/placeholders/replace` — Resolve placeholders: Resolves PlaceholderAPI placeholders in a message for a player. ### Plugins List, install, enable, and disable plugins. - `GET /v1/plugins` — List plugins: Returns all installed plugins. - `POST /v1/plugins` (admin) — Install a plugin: Downloads and installs a plugin from a URL. - `POST /v1/plugins/{name}/enable` (admin) — Enable a plugin: Enables an installed plugin. - `POST /v1/plugins/{name}/disable` (admin) — Disable a plugin: Disables an installed plugin. ### Worlds Inspect worlds, control time and weather, save, and download. - `GET /v1/worlds` — List worlds: Returns all loaded worlds. - `POST /v1/worlds/{uuid}/time` — Set time: Sets the in-game time for a world. - `POST /v1/worlds/{uuid}/weather` — Set weather: Sets the weather for a world. - `POST /v1/worlds/save` (admin) — Save all worlds: Saves all loaded worlds to disk. - `GET /v1/worlds/download` (admin) — Download all worlds: Downloads a ZIP archive of all worlds. Returns application/zip. ### Network Aggregate status and control across a multi-server network. - `GET /v1/network/status` — Network status: Returns the status of all servers in the network. - `GET /v1/network/health` — Network health: Returns aggregate TPS and memory across the network. - `GET /v1/network/players` — Network players: Returns aggregate online players across the network. - `GET /v1/network/players/{uuid}` — Find a player: Finds which network server a player is on. - `POST /v1/network/broadcast` — Network broadcast: Broadcasts a message to all servers in the network.