POST /kick/{player_identifier}
Endpoint: POST /v1/pdapi/kick/<player_identifier>
Auth: Bearer token
Permission: REST.Punishments.Kick
Purpose
Kicks an online player without creating a ban record.
Path parameters
player_identifier:UserId,PlayerUID, or another supported player identifier.
Query parameters
None.
Request body
Optional JSON field: Reason string.
Response schema
200 response schema
| Field | Type | Description |
|---|---|---|
Success |
boolean | true when the player was kicked. |
UserId |
string | User ID that was kicked. |
Error responses
Error bodies use this shape:
| 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. |
404 |
PLAYER_NOT_FOUND |
The target player is not online or could not be found. |
Examples
Kick a GDK player with reason
Kick a Steam player with default reason
Scenarios
- Remove a player before maintenance.
- Kick a stuck player so they can reconnect.
- Use POST /ban instead when the player should not be allowed back.