Endpoint description

Get players information

Endpoint route

GET

/api/v1/players

Response type

Application/Json

Header parameters

KeyValueTypeRequired
AuthorizationBasic [key]stringFor Basic authentication mode only
Authorization[key]stringFor Key-Basic and Key-Advanced authentication modes only

Query Parameters

No parameters

Body parameters

No parameters

Access rights

Authentication typeKey typeAllowed
Openfalse
Basicfalse
Key-Basicfalse
Key-AdvancedPublic keyfalse
Key-AdvancedProtected keyfalse
Key-AdvancedAdmin keyfalse

Success response

{
    "onlinePlayers": int,
    "offlinePlayers": int,
    "maxPlayers": int
}

Error response

{
    "success": bool,
    "code": int,
    "message": string
}

Return codes

HTTP CodeType
200OK
401Unauthorized
403Forbidden