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.

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.

Network (Multi-Server)

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

For multi-server architectures with a proxy (Velocity / BungeeCord).