POST /banip/{ip}

Endpoint: POST /v1/pdapi/banip/<ip>

Auth: Bearer token

Permission: REST.Punishments.BanIP

Purpose

Bans an IP address and records it in Banlist.json.

None.

Optional JSON fields: Reason string and UserId string when the IP ban should be associated with a user.

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 bodies use this shape:

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

HTTP	Error code	When it happens
`401`	`INVALID_TOKEN`	The `Authorization` header is missing, malformed, or does not match a configured bearer token.
`403`	`MISSING_PERMISSION`	The token is valid, but it does not include this endpoint permission.
`400`	`INVALID_JSON`	A request body was supplied, but it could not be parsed as JSON.
`400`	`REQUEST_FAILED`	The game-thread callback threw an exception, or a shared player/resource resolver failed.
`500`	`REQUEST_TIMEOUT`	The internal game-thread callback did not complete within 5 seconds.
`400`	`VALIDATION_FAILED`	An optional request field has the wrong JSON type.

POST /v1/pdapi/banip/203.0.113.42

{
    "Reason": "Bot traffic"
}

POST /v1/pdapi/banip/198.51.100.87

{
    "Reason": "Alt account abuse",
    "UserId": "gdk_2533274898765432"
}