LuckPerms REST API

REST API for LuckPerms as a Paper plugin.

Requirements

Component	Minimum
Java	16
Paper	1.16.5
LuckPerms	API 5.5

Installation

1. Copy plugin to the server plugins directory.
2. Make sure LuckPerms (v5.5 API or newer) is installed.
3. Edit plugins/LuckPermsRestApi/config.yml and restart the server.

The API listens on http://localhost:8080 by default. The OpenAPI schema is available at http://localhost:8080/docs/openapi.

Configuration

http-port: 8080
auth: false
auth-keys: ''
cache-users: true
cache-groups: true
cache-tracks: true

When auth is enabled, provide comma-separated API keys in auth-keys and send them as Authorization: Bearer <key>.