Перейти к содержанию

POST /banip/{ip}

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

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

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

Цель

Блокирует IP-адрес и записывает его в Banlist.json.

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

  • ip: IP-адрес для блокировки.

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

Нет.

Тело запроса

Необязательные поля JSON: Reason string и UserId string, когда бан по IP должен быть связан с пользователем.

Схема ответа

200 response schema

Field Type Description
Success boolean true when the IP ban was recorded.
IP string IP address that was banned.
UserId string Optional user ID recorded with the IP ban.
Kicked integer Number of online players kicked from that IP address.

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

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

{
    "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.

Примеры

Запретить только IP

POST /v1/pdapi/banip/203.0.113.42
{
    "Reason": "Bot traffic"
}

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

POST /v1/pdapi/banip/198.51.100.87
{
    "Reason": "Alt account abuse",
    "UserId": "gdk_2533274898765432"
}

Сценарии

  • Прекратите повторные злоупотребления с одного и того же IP-адреса после проверки сотрудниками.
  • Свяжите UserId, если он известен, чтобы список банов было легче проверять.
  • Используйте GET /banlist с ip для проверки активной записи.