API Reference

The Zander REST API is the backbone that connects every component — Minecraft plugins call it to record sessions and relay chat, the Discord bot reads it for punishments and events, and the web dashboard uses it for everything from announcements to voting. If you're building an integration or troubleshooting, this is your reference.

All Minecraft plugins connect to this API to read and write data.

Base URL

https://<your-site>/api

The base URL is set by siteAddress in your .env file.

Response Format

All API endpoints return JSON in the following structure:

Success:

{
  "success": true,
  "data": { ... }
}

Error:

{
  "success": false,
  "message": "Error description"
}

Some endpoints return additional pagination metadata (e.g. page, limit) alongside data.

HTTP Status Codes

Code	Meaning
200	Success
400	Bad request — missing or invalid parameters
401	Unauthorised — missing or invalid API token
403	Forbidden — feature disabled or permission denied
404	Not found
500	Internal server error

Authentication

See Authentication for details on how to authenticate API requests.

Endpoint Groups

Group	Base Path	Description
Announcements	/api/announcement	Create and manage announcements
Applications	/api/application	Manage application listings
Bridge	/api/bridge	Command executor bridge
Command Bridge	/command-bridge	Vote reward command delivery to plugins
Config	/policy, /social	Site configuration and social links
Discord	/api/discord	Minecraft-to-Discord relay
Discord Punishments	/api/discord-punishments	Discord punishment records and appeals
Events	/api/events	Event management
Filter	/api/filter	Content filtering
Forms	/api/forms	Custom forms and response management
Punishments	/api/punishments	Punishment log
Ranks	/api/rank	Rank management via LuckPerms
Reports	/api/report	Player reports
Scheduler	/api/scheduler	Scheduled Discord messages
Servers	/api/server	Server registry
Sessions	/api/session	Player session tracking
Shop Directory	/api/shop	In-game shop listings
Upload	/api/upload	Image upload via Cloudinary
Users	/api/user	User accounts and profiles
Vault	/api/vault	Vault entries
Voting	/vote, /admin/vote	Vote tracking and rewards
Watch	/api/watch	Creator content
Web	/api/web	Site stats and configuration

Full endpoint details are in Endpoints.