端點Endpoints
每個端點同時掛在兩個路徑。/api/v1/{端點} 是版本化路徑,對外串接請用這個;
/api/{端點} 是別名,永遠指向最新版本。
GET /api/v1 會列出目前啟用的所有端點。
| 端點 | 內容 | 預設需金鑰 |
|---|---|---|
/status | 線上玩家 UUID 與人數、Discord 成員數 | |
/status?history=true | 附上人數的時間序列(新到舊) | |
/player/{uuid} | 名稱、rank、暱稱、遊玩時長、AFK、餘額、Discord | |
/player/{uuid}?detailed=true | 展開方塊/物品/實體細項統計 | |
/server | 版本、MOTD、最大玩家數、遊戲模式 | ✓ |
/performance | TPS、tick 時間、記憶體、JVM | ✓ |
/worlds、/worlds/{name} | 世界列表與細節 | ✓ |
/gamerules | 各世界的 game rule | ✓ |
/entities | 各世界實體統計,排除玩家 | ✓ |
/spawnlimits | 生怪上限與間隔 | ✓ |
/punishments | 處罰紀錄與統計 | ✓ |
/bans | 封鎖名單(UUID 與 IP) | ✓ |
/operators | 管理員名單 | ✓ |
/whitelist | 白名單狀態與名單 預設關閉 | ✓ |
/plugins | 已安裝插件列表 | ✓ |
/placeholders?uuid=&p= | 解析 PlaceholderAPI 變數 | ✓ |
/network | 跨伺服器彙整 預設關閉,需多服 + Redis | ✓ |
/constants | 靜態列舉參考 | ✓ |
實體統計刻意排除玩家,以免間接洩漏線上玩家資訊。
未啟用或不存在的端點一律回 404。停用的端點在索引中也不會出現。
Every endpoint is served at two paths. /api/v1/{endpoint} is the versioned path and
is what you should use for integrations; /api/{endpoint} is an alias that always points
at the latest version.
GET /api/v1 lists every endpoint currently enabled.
| Endpoint | Returns | Key by default |
|---|---|---|
/status | Online player UUIDs and count, Discord members | |
/status?history=true | Adds a time series of the counts, newest first | |
/player/{uuid} | Name, rank, nickname, playtime, AFK, balance, Discord | |
/player/{uuid}?detailed=true | Expands per-block / item / entity stats | |
/server | Version, MOTD, max players, game mode | ✓ |
/performance | TPS, tick time, memory, JVM | ✓ |
/worlds, /worlds/{name} | World list and detail | ✓ |
/gamerules | Game rules per world | ✓ |
/entities | Entity counts per world, players excluded | ✓ |
/spawnlimits | Spawn limits and intervals | ✓ |
/punishments | Punishment records and statistics | ✓ |
/bans | Ban list (UUIDs and IPs) | ✓ |
/operators | Operator list | ✓ |
/whitelist | Whitelist state and entries Off by default | ✓ |
/plugins | Installed plugin list | ✓ |
/placeholders?uuid=&p= | Resolve PlaceholderAPI placeholders | ✓ |
/network | Cross-server aggregation Off by default, needs multi-server + Redis | ✓ |
/constants | Static enum reference | ✓ |
Entity counts deliberately exclude players so they cannot leak who is online.
Disabled or unknown endpoints return 404, and disabled ones do not appear in the index.