HTTP API
Connect Gatekeeper to websites, Discord bots, dashboards, and other applications.
Base URL
By default the API runs at:
http://127.0.0.1:8123/api/v1Public and admin API
| API | What it can do |
|---|---|
| Public | Provide player and status information, including public profile fields. |
| Authenticated admin | Manage players, statuses, profile fields, logs, and configuration. |
Admin token
The admin API uses the token in config/gatekeeper/config.json, under:
api.adminApi.tokenKeep this token private. It gives access to administrative functions.
Things to build
- A public member list or player page on your website
- A Discord bot that approves applicants by changing their status
- A dashboard showing join and audit activity
Exposing the API
The API is bound to localhost by default. If you expose it outside your server, put it behind a TLS reverse proxy. See Security.