Remove Client

Remove Client

Removes a WireGuard client from the server.

phantom-api core remove_client client_name="john-laptop"

Parameters:

Parameter	Required	Description
client_name	Yes	Name of the client to remove

Response Model: ClientRemoveResult

Field	Type	Description
removed	boolean	Whether removal was successful
client_name	string	Name of the removed client
client_ip	string	IP address of removed client

Example Response

{
  "success": true,
  "data": {
    "removed": true,
    "client_name": "john-laptop",
    "client_ip": "10.8.0.2"
  },
  "metadata": {
    "module": "core",
    "action": "remove_client",
    "timestamp": "2025-09-09T01:16:45.684652Z",
    "version": "core-v1"
  }
}