DOCUMENTATION

API Docs

OpenAPI 3.0, REST endpoints, curl examples and Zod schemas. Swagger UI is served by the API, on the same origin as the site.

SWAGGER UI

Interactive /api/docs

Every route documented, request/response schemas, built-in try-it-out.

Open Swagger

OpenAPI JSON

Downloadable spec

Direct import into Postman, Insomnia or your favorite client generator.

/api/docs/json

Protected routes authenticate with the sf_access cookie (set at sign-in); server-to-server endpoints with the x-api-key header. "Try it out" therefore works straight from a browser that is already signed in.

The API is capped at 100 requests per minute per IP, with stricter limits on some routes (sign-in: 5/min). The documentation pages themselves are not counted against it.

EXAMPLE — RP server-side whitelist verification

# Endpoint sécurisé par clé API serveur (header x-api-key)
curl -X GET "https://sixforge.cloud/api/subscriptions/whitelist/verify?serverId=fr1&discordId=218501289348390912" \
  -H "x-api-key: $WHITELIST_API_KEY"

# → 200 OK
{
  "whitelisted": true,
  "status": "approved",
  "subscriptionActive": true
}