WardenCoredocs
APIEndpoints

Server

The server's identity and live status.

Returns the identity and live status of the server your key belongs to — a quick way to check that the key works and the server is reachable.

Endpoint

GET https://api.wardencore.ru/v1/server

Authorization

Requires the server:read scope. A key without it gets 403 insufficient_scope.

GET /v1/server HTTP/1.1
Host: api.wardencore.ru
Authorization: Bearer wc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response

200 OKapplication/json:

{
  "server_id": "clx9f2c…",
  "name": "My SCUM Server",
  "online": true,
  "player_count": 12,
  "mod_version": "2.0.99"
}
FieldTypeDescription
server_idstringThe server's stable identifier (the key is bound to this server).
namestring | nullThe display name set in the panel. null if none is set.
onlinebooleanAlways true in a 200 response — see below.
player_countinteger | nullPlayers currently online. null if the mod does not report it.
mod_versionstring | nullThe running WardenCore mod version (e.g. 2.0.99).

Live status

This endpoint proxies to the WardenCore mod on your server over its live connection. If the server is offline it returns 503 server_unavailable (with Retry-After) rather than online: false — so a 200 response always means the server is reachable. See Server availability.

Errors

Standard error envelope. The ones you're most likely to hit:

CodeStatusWhen
unauthorized401Missing, malformed, expired, or revoked key.
insufficient_scope403The key lacks server:read.
server_unavailable503The game server is offline or unreachable.
gateway_timeout504The server did not respond in time.

On this page