POST /banip/{ip}
Ponto final: POST /v1/pdapi/banip/<ip>
Autenticação: Token do portador
Permissão: REST.Punishments.BanIP
Objetivo
Bane um endereço IP e o registra em Banlist.json.
Parâmetros de caminho
ip: endereço IP a ser banido.
Parâmetros de consulta
Nenhum.
Solicitar corpo
Campos opcionais JSON: Reason string e UserId string quando o banimento de IP deve ser associado a um usuário.
Esquema de resposta
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. |
Respostas de erro
Os corpos de erro usam esta forma:
| HTTP | Código de erro | Quando isso acontece |
|---|---|---|
401 |
INVALID_TOKEN |
O cabeçalho Authorization está ausente, malformado ou não corresponde a um token de portador configurado. |
403 |
MISSING_PERMISSION |
O token é válido, mas não inclui essa permissão de endpoint. |
400 |
INVALID_JSON |
Um corpo de solicitação foi fornecido, mas não pôde ser analisado como JSON. |
400 |
REQUEST_FAILED |
O retorno de chamada do thread do jogo gerou uma exceção ou um resolvedor player/resource compartilhado falhou. |
500 |
REQUEST_TIMEOUT |
O retorno de chamada do thread de jogo interno não foi concluído em 5 segundos. |
400 |
VALIDATION_FAILED |
Um campo de solicitação opcional tem o tipo JSON errado. |
Exemplos
Banir apenas um IP
Banir um IP e anexar um usuário GDK
Cenários
- Pare de abusos repetidos do mesmo IP após revisão da equipe.
- Associe
UserIdquando conhecido para que a lista banida seja mais fácil de auditar. - Use GET /banlist com
ippara verificar o registro ativo.