API Reference

Endpoints

Every NoxAeApi endpoint, grouped by resource. Use the search box to filter by path, method, or description. Base URL is your server host on the configured port, e.g. http://your-server:8080.

Server

Server information, administration, whitelist, ops, scoreboard, and console.

Players

Online and offline player management: bans, kicks, gamemode, teleportation, and stats.

Chat

Server-wide broadcast and direct player messaging.

Economy

Player balances and transactions via a Vault-compatible economy plugin.

Requires a Vault-compatible economy plugin. Returns 424/503 if none is loaded.

Advancements

Query registered server advancements and player milestone records.

LuckPerms

Groups and permission nodes for players and permission groups.

Requires LuckPerms. Returns 503 if not loaded.

Skills

Read player RPG skill levels from mcMMO or AuraSkills.

Per-plugin. Returns 503 if the requested plugin is not loaded.

NoxAuth

Player authentication status and password verification. Uses player names, not UUIDs.

Requires NoxAuth plugin.

PlaceholderAPI

Parse and replace PlaceholderAPI placeholders in a string.

Requires PlaceholderAPI plugin.

Plugins

List, install, enable, and disable server plugins.

Worlds

Inspect world state, set time and weather, save to disk, and download ZIP backups.

Leaderboards

Generic leaderboard manager fetching top ranked player data across registered tracking sources.

Network (Multi-Server)

Aggregated status and fleet control across a multi-server proxy network.

Requires NoxAeApi on BungeeCord/Velocity with network aggregator enabled. For the newer push-based NoxAeApi-Velocity network hub (separate plugin, separate port), see the 'Network Hub' category instead.

Network Hub (Velocity Proxy)

Push-based network status, aggregate players, and broadcasts served by the standalone NoxAeApi-Velocity plugin.

Requires the separate NoxAeApi-Velocity plugin running on the Velocity proxy. Runs on its own port — do not confuse with the "Network" category above, which is NoxAeApi-main's built-in polling aggregator on a single backend.

WebSocket Streams

Real-time two-way and streaming WebSocket connections for live console logs and game events.

WebSocket connections authenticate using ?key= query parameter during the HTTP upgrade handshake.