Skip to main content
GET
Fetch server information

Authorizations

server-key
string
header
required

REQUIRED ON ALL REQUESTS. Get your server key at https://erlc.link/sk

Headers

Authorization
string

OPTIONAL. ONLY provide this header if you are creating a public app (used in many unique servers). Register your app at https://apidocs.erlc.gg/creating-public-applications.

Query Parameters

Players
boolean

Include player list in response

Example:

true

Staff
boolean

Include staff list (Admins, Mods, Helpers) in response

Example:

true

JoinLogs
boolean

Include join logs in response

Example:

true

Queue
boolean

Include queue data in response

Example:

true

KillLogs
boolean

Include kill logs in response

Example:

true

CommandLogs
boolean

Include command logs in response

Example:

true

ModCalls
boolean

Include moderator call logs in response

Example:

true

EmergencyCalls
boolean

Include emergency call logs in response

Example:

true

Vehicles
boolean

Include vehicle list in response

Example:

true

Response

Requested data. Optional fields only included when query=true.

Name
string
required
Example:

"API Test"

OwnerId
integer
required
CoOwnerIds
integer[]
required
CurrentPlayers
integer
required
MaxPlayers
integer
required
JoinKey
string
required
Example:

"APIServer"

AccVerifiedReq
string
required
Example:

"Disabled / Email / Phone/ID"

TeamBalance
boolean
required
Players
object[]

Only included when Players=true query parameter is provided

Staff
object

Only included when Staff=true query parameter is provided

JoinLogs
object[]

Only included when JoinLogs=true query parameter is provided

Queue
integer[]

Only included when Queue=true query parameter is provided

KillLogs
object[]

Only included when KillLogs=true query parameter is provided

CommandLogs
object[]

Only included when CommandLogs=true query parameter is provided

ModCalls
object[]

Only included when ModCalls=true query parameter is provided

EmergencyCalls
object[]

Only included when EmergencyCalls=true query parameter is provided

Example:
Vehicles
object[]

Only included when Vehicles=true query parameter is provided