REST API
Every plugin with a backend has one at api.<plugin>.soknight.me. The plugins use these APIs; you
can call them too, with a server token.
Common endpoints
Section titled “Common endpoints”| Method | Path | Auth | Description |
|---|---|---|---|
| GET | / |
— | Service name, version and docs link |
| GET | /health |
— | status, version and region |
| GET | /api/v1/version |
— | Current version and release date |
| GET | /api/v1/openapi.json |
— | Full OpenAPI 3.0 document |
Each plugin’s own endpoints are listed on its API page, for example StreamGate API.
Authentication
Section titled “Authentication”Authorization: Bearer <server token>Requests without a token, or with a revoked one, get 401 and
{"error":"unauthorized"}. Unknown paths outside /api/v1/ answer 404.
Limits
Section titled “Limits”Public endpoints allow 60 requests per minute per address. Authenticated endpoints have per-plugin
limits, listed under /api/v1/limits where the plugin has one.
Versioning
Section titled “Versioning”The v1 prefix stays until a breaking change. Fields may be added at any time; ignore the ones you do
not know.