Endpoint description

Get banned players/IPs information

Endpoint route

GET

/api/banned

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

    
{
    "bannedPlayers": int,
    "bannedIPs": int,
    "players": array[string],
    "ip": array[string]             // - For Admin keys only
}

Error response

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

Return codes

HTTP CodeType
200OK
401Unauthorized
403Forbidden