POST /banip/{ip}
Point final : POST /v1/pdapi/banip/<ip>
Auth : Jeton du porteur
Autorisation : REST.Punishments.BanIP
Objectif
Interdit une adresse IP et l'enregistre dans Banlist.json.
Paramètres du chemin
ip: Adresse IP à bannir.
Paramètres de requête
Aucun.
Corps de la demande
Champs JSON facultatifs : Reason string et UserId string lorsque le bannissement IP doit être associé à un utilisateur.
Schéma de réponse
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. |
Réponses aux erreurs
Les corps d'erreur utilisent cette forme :
| HTTP | Code d'erreur | Quand ça arrive |
|---|---|---|
401 |
INVALID_TOKEN |
L'en-tête Authorization est manquant, mal formé ou ne correspond pas à un jeton de support configuré. |
403 |
MISSING_PERMISSION |
Le jeton est valide, mais il n'inclut pas cette autorisation de point de terminaison. |
400 |
INVALID_JSON |
Un corps de requête a été fourni, mais il n'a pas pu être analysé comme JSON. |
400 |
REQUEST_FAILED |
Le rappel du thread de jeu a généré une exception ou un résolveur player/resource partagé a échoué. |
500 |
REQUEST_TIMEOUT |
Le rappel du thread de jeu interne ne s'est pas terminé dans les 5 secondes. |
400 |
VALIDATION_FAILED |
Un champ de requête facultatif a un type JSON incorrect. |
Exemples
Interdire une IP uniquement
Bannir une IP et attacher un utilisateur GDK
Scénarios
- Arrêtez les abus répétés de la même adresse IP après examen par le personnel.
- Associez
UserIdlorsqu'il est connu afin que la liste de bannissement soit plus facile à auditer. - Utilisez GET /banlist avec
ippour vérifier l'enregistrement actif.