SentinelShare developer docs
SentinelShare is a shared ban network for Arma Reforger communities. Server staff file bans for cheating, exploiting, duping, racism and DDoS threats, other communities verify them, and every member community can use the list. These docs show your developers how to bring that list into your own tools.
What you can build
| You want to | Use | Start here |
|---|---|---|
| Show network bans inside your admin panel | The admin panel API: a change feed your panel syncs from | Admin panel API |
| Check players when they join your game server or panel | The lookup endpoint | Admin panel API |
| Do it in a Laravel or PHP panel | A ready-made sync command and join check | Laravel and PHP |
| Do it in Node.js or Python | Copy-paste sync loops and lookups | Node.js and Python |
| Let your staff check, add and remove bans from Discord | The official SentinelShare bot | Add the SentinelShare bot |
| Find banned players already in your Discord | /bans scan with the official bot; the report is saved on the website | Scan your Discord |
| Warn your staff when a banned player joins your Discord | Staff alerts from the official bot, or your own bot calling the lookup endpoint | Staff alerts, Build your own Discord bot |
Before you start
- Your community needs to be on SentinelShare. A SentinelShare network admin adds your community and makes your server owner a Server Owner account. Ask a SentinelShare network admin.
- Your server owner creates an API key. They sign in at sentinelshare.com with Discord, open API keys and press Create key. Keys start with
ssk_, are read-only, and belong to your community, so they keep working when staff change. - Give the key to your developer privately. Anyone with it can read every ban on the network, including players' IP addresses. Keep it in server-side config, never in a browser, a public repo or a screenshot.
The API in one minute
- Base URL:
https://sentinelshare.com/api/v1/integration - Send your key on every request:
Authorization: Bearer ssk_… GET /bansreturns bans created or changed since your last call. Store them byid, replace on repeat, and call again withsince=<next_cursor>every few minutes.GET /lookup?arma_uid=…(ordiscord_id,ip,name) returns one player and all their bans.- 300 requests a minute per key.
Giving these docs to an AI assistant
Every page has Download .md and Copy as Markdown buttons. To hand the whole set to an AI coding assistant in one go:
- Download all the docs as one file and attach or paste it into your assistant, then describe your panel: framework, database, where players join.
- Tools that read
llms.txtcan start from sentinelshare.com/llms.txt.
A good prompt to start with: "Using the attached SentinelShare docs, add a scheduled job to my Laravel admin panel that syncs SentinelShare bans into a sentinel_bans table, and flag players on join whose Arma UID has an active ban."
Getting help
- The machine-readable API reference is at /api/v1/docs.
- Questions, or a field you need that isn't there: ask a SentinelShare network admin.
- What changed and when: Changelog.