POST /ban/{player_identifier}

Endpoint: POST /v1/pdapi/ban/<player_identifier>

Auth: Bearer token

Permission: REST.Punishments.Ban

Purpose

Bans a user and records the ban in Banlist.json. The target may be kicked if currently online.

player_identifier: UserId, PlayerUID, or another supported player identifier.

None.

Optional JSON fields: Reason string and IP boolean. Set IP to true only when you also want to ban the resolved IP address.

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 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.
`400`	`IP_UNAVAILABLE`	`IP` was `true`, but the server could not resolve an IP for the target user.

POST /v1/pdapi/ban/steam_76561198012345678

{
    "Reason": "Chargeback fraud"
}

POST /v1/pdapi/ban/ps5_0f4b8c2d91aa34ef

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

Ban a player by UserId after moderation review.
Include a clear reason so future staff can understand the banlist entry.
Use GET /banlist to verify the active record. Ban-related data is no longer managed in Config.json.