The full reference is in Swagger at api.gamesentry.gg/swagger, generated from the API itself so it always matches.
Get a key
- 1
Open API Keys in the organization menu.
- 2
Create a key and tick only the scopes it needs.
- 3
Confirm with two factor authentication.
- 4
Copy the key. It starts with gs_live_ and is shown only once.
Send it in the X-API-Key header, or as Authorization: Bearer followed by the key.
| Scope | Allows |
|---|
| servers:read | Your servers and their details |
| players:read | Players and who is online |
| analytics:read | Server statistics |
| bans:read | Bans across your servers |
| automation:read | Your automation rules |
| webhooks:write | Webhook subscriptions and the signing secret |
Limits
Each IP can make 300 requests per minute, and each organization has a daily quota. When you hit a limit the API answers 429 with a Retry-After header.
Keep keys out of websites and public repositories. Make one key per integration.
