Zum Inhalt

POST /kick/{player_identifier}

Endpunkt: POST /v1/pdapi/kick/<player_identifier>

Auth: Bearer-Token

Berechtigung: REST.Punishments.Kick

Zweck

Kickt einen Online-Spieler, ohne einen Banneintrag zu erstellen.

Pfadparameter

  • player_identifier: UserId, PlayerUID oder eine andere unterstützte Spielerkennung.

Query-Parameter

Keine.

Request-Body

Optionales JSON-Feld: Reason als String.

Antwortschema

Schema der 200-Antwort

Feld Typ Beschreibung
Success boolean true, wenn der Spieler vom Server entfernt wurde.
UserId string Benutzer-ID des entfernten Spielers.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}
HTTP Fehlercode Wann es passiert
401 INVALID_TOKEN Der Authorization-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
403 MISSING_PERMISSION Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.
400 INVALID_JSON Ein Request-Body wurde gesendet, konnte aber nicht als JSON gelesen werden.
400 REQUEST_FAILED Der Game-Thread-Callback hat eine Ausnahme ausgelöst oder ein gemeinsamer Spieler-/Ressourcen-Resolver ist fehlgeschlagen.
500 REQUEST_TIMEOUT Der interne Game-Thread-Callback wurde nicht innerhalb von 5 Sekunden abgeschlossen.
400 VALIDATION_FAILED Ein optionales Anfragefeld besitzt den falschen JSON-Typ.
404 PLAYER_NOT_FOUND Der Zielspieler ist nicht online oder konnte nicht gefunden werden.

Beispiele

Einen GDK-Spieler mit Begründung entfernen

POST /v1/pdapi/kick/gdk_2533274812345678
{
    "Reason": "AFK in event area"
}

Einen Steam-Spieler mit Standardbegründung entfernen

POST /v1/pdapi/kick/steam_76561198087654321
{}

Szenarien

  • Einen Spieler vor Wartungsarbeiten entfernen.
  • Einen festhängenden Spieler entfernen, damit er sich erneut verbinden kann.
  • Nutze stattdessen POST /ban, wenn der Spieler nicht zurückkehren dürfen soll.