POST /ban/{player_identifier}

Конечная точка: POST /v1/pdapi/ban/<player_identifier>

Аутентификация: Токен носителя

Разрешение: REST.Punishments.Ban

Цель

Банит пользователя и записывает бан в Banlist.json. Цель может быть кикнута, если она в данный момент онлайн.

Параметры пути

player_identifier: UserId, PlayerUID или другой поддерживаемый идентификатор игрока.

Параметры запроса

Нет.

Тело запроса

Необязательные поля JSON: Reason string и IP логические значения. Установите для IP значение true только в том случае, если вы также хотите заблокировать разрешенный IP-адрес.

Схема ответа

200 response schema

Field	Type	Description
`Success`	boolean	`true` when the ban was recorded.
`UserId`	string	User ID that was banned.
`IP`	boolean	Whether the request also banned an IP address.
`BannedIP`	string	Banned IP address, or an empty string when no IP was banned.
`Kicked`	integer	Number of online players kicked by the ban action.

Реакции на ошибки

Тела ошибок используют следующую форму:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}

HTTP	Код ошибки	Когда это произойдет
`401`	`INVALID_TOKEN`	Заголовок `Authorization` отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя.
`403`	`MISSING_PERMISSION`	Токен действителен, но не включает это разрешение конечной точки.
`400`	`INVALID_JSON`	Текст запроса был предоставлен, но его не удалось проанализировать как JSON.
`400`	`REQUEST_FAILED`	Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource.
`500`	`REQUEST_TIMEOUT`	Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд.
`400`	`VALIDATION_FAILED`	Необязательное поле запроса имеет неверный тип JSON.
`400`	`IP_UNAVAILABLE`	`IP` был `true`, но серверу не удалось определить IP-адрес целевого пользователя.

Примеры

Заблокировать пользователя Steam

POST /v1/pdapi/ban/steam_76561198012345678

{
    "Reason": "Chargeback fraud"
}

Заблокировать пользователя PS5 и его разрешенный IP-адрес

POST /v1/pdapi/ban/ps5_0f4b8c2d91aa34ef

{
    "Reason": "Ban evasion",
    "IP": true
}

Сценарии

Заблокируйте игрока UserId после проверки модерацией.
Укажите четкую причину, чтобы будущие сотрудники могли понять запись в запретном списке.
Используйте GET /banlist, чтобы проверить активную запись. Данные, связанные с баном, больше не управляются в Config.json.