HomeGetting startedRegistering with an HTTP keyGetting a credential without DiscordServer claim flowReport rules and the block windowVersion check and 426Authentication and server keysThe blocking modelError handlingRate limitsVersions and compatibilityPOST /v1/servers/claimPOST /v1/servers/reportPOST /v1/servers/revokePOST /plugin/v1/claimPOST /plugin/v1/reportGET /plugin/v1/versionGET /maps/{seed}GET /jobs/{seed}GET /seedsGET /stats/overviewGET /stats/protectionAPI changelog
Concepts
Versions and compatibility
v1 paths only ever gain fields. A client deployed today keeps working without changes.
The promise
- No response field is removed or given a new meaning.
- No new required request field is introduced. New fields are optional.
- New response fields may appear at any time. Ignore fields you do not know.
- Error strings never change. New ones may be added, so handle unknown errors by status code.
- If that promise ever has to break, a new /api/v2 path opens. /api/plugin/v1/* stays forever because deployed plugins keep calling it.
Rules for clients
- Parse JSON leniently. An unknown key must not be a failure.
- Look at the status code first, then at the error string.
- blockedUntil may be null. exhausted exists only when it is true.
- Timestamps are ISO-8601 UTC strings and may carry fractional seconds.
Plugin minimum version
This rule exists only on the official plugin path (/api/plugin/v1/*). When the operator sets a minimum, claim and report with a lower pluginVersion are refused with 426. GET /api/plugin/v1/version tells you in advance. The server API (/api/v1/servers/*) has no version check.
Changelog
Every change to endpoints or rules is listed by date on the changelog page.
SLMAPS is the seed-map viewer for SCP: Secret Laboratory. These pages describe the public API of slmaps.com.slmaps.com ·