Skip to main content

Endpoints

Every endpoint - method, path, parameters, request/response schema, and auth requirement - is documented in the interactive API Reference, generated directly from the OpenAPI spec and grouped the same way as the table below. This page is a map of that reference, not a duplicate of it.

All endpoints require the x-access-token header unless the interactive reference marks them public or session-authenticated. Feature-gated endpoints additionally require the relevant feature to be enabled in features.json.

Groups

GroupBase PathDescriptionReference
Announcements/api/announcementCreate and manage announcements
Applications/api/applicationManage application listings
Auth & Sessions/api/sessionPlayer session tracking
Badges/api/badges, /admin/badgesProfile achievement badges
Bridge/api/bridgeCommand executor bridge
Command Bridge/command-bridgeVote reward command delivery to plugins
Discord Relay/api/discordMinecraft-to-Discord relay
Discord Punishments/api/discord-punishmentsDiscord punishment records and appeals
Events/api/eventsEvent management (public, authenticated, and template endpoints)
Filter/api/filterContent filtering
Finance/api/financeDashboard-only income/expense/budget tracker
Forms/api/formsCustom forms and response management
Forums/forums, /dashboard/forumsForum discussions, replies, polls, and moderation. Mostly HTML/redirect responses, not JSON
Mixed/api/mixedPGM ("Mixed") server stats portal: plugin ingestion, public/user API, live SSE stream, admin API, and the Stripe webhook
Punishments/api/punishmentsPublic punishment log (reads the external LiteBans database)
Ranks/api/rankRank management via LuckPerms
Reports/api/reportPlayer reports
Scheduler/api/schedulerScheduled Discord messages
Servers/api/serverServer registry
Shop Directory/api/shopIn-game shop listings
Upload/api/uploadImage upload via Cloudinary
Users/api/userUser accounts and profiles
Vault/api/vaultVault entries
Voting/vote, /admin/voteVote tracking and rewards
Watch/api/watchCreator content
Web/api/web, /policy, /socialSite stats, configuration, and policy/social links

Notes worth reading before you integrate

A few things don't fit neatly into a per-endpoint reference and are easy to miss:

  • Forums is mostly not a JSON API. Its routes render server-side HTML and respond with redirects - they're form-submission targets for the forum UI. The one exception is the post-report endpoint. See Forums.
  • Mixed's plugin-ingestion endpoints use Authorization: Bearer <apiKey> - the same app-wide key as everywhere else, not a Mixed-specific token. vote/current and vote/cast accept either a browser session or that plugin token (see Mixed and Authentication).
  • Two unrelated Stripe webhooks exist: /api/stripe/webhook (Mixed's Map Tokens / Supporter purchases) and the Webstore's own webhook - don't conflate them. See Webstore.
  • Two separate "punishments" systems exist: /api/punishments/get reads the external LiteBans database (read-only, public log); the dashboard's Web Punishments feature writes to this app's own discord_punishments table and never touches LiteBans. See Punishments.
  • The rank, server, and scheduler write endpoints (/api/rank/*, /api/server/*, /api/scheduler/*) are gated by the dashboard UI's session check but were flagged during an audit as potentially missing an equivalent in-route check on the API endpoints themselves - see the interactive reference and each feature page for the current status of that finding.