POST /kick/{player_identifier}
端点: POST /v1/pdapi/kick/<player_identifier>
认证: Bearer 令牌
权限: REST.Punishments.Kick
用途
踢出在线玩家,但不创建封禁记录。
路径参数
player_identifier:UserId,PlayerUID, or another supported player identifier.
查询参数
无。
请求体
可选 JSON 字段:字符串 Reason。
响应结构
200 response schema
| Field | Type | Description |
|---|---|---|
Success |
boolean | true when the player was kicked. |
UserId |
string | User ID that was kicked. |
错误响应
错误响应使用以下格式:
| HTTP | 错误代码 | 发生条件 |
|---|---|---|
401 |
INVALID_TOKEN |
Authorization 头缺失、格式错误,或与配置的 Bearer 令牌不匹配。 |
403 |
MISSING_PERMISSION |
令牌有效,但不包含此端点权限。 |
400 |
INVALID_JSON |
提供了请求体,但无法解析为 JSON。 |
400 |
REQUEST_FAILED |
游戏线程回调抛出异常,或共享玩家/资源解析器失败。 |
500 |
REQUEST_TIMEOUT |
内部游戏线程回调未在 5 秒内完成。 |
400 |
VALIDATION_FAILED |
An optional request field has the wrong JSON type. |
404 |
PLAYER_NOT_FOUND |
目标玩家不在线或无法找到。 |
示例
Kick a GDK player with reason
Kick a Steam player with default reason
使用场景
- Remove a player before maintenance.
- Kick a stuck player so they can reconnect.
- 如果不应允许玩家返回,请改用 POST /ban。