API Reference
Dashboard
  1. API Reference
  2. Box API
  3. VPS forwarding

Recreate one forwarding service on the box and the VPS

Re-creates the named service (box unit and/or VPS relay entry). Connections through that service drop while it restarts.

  • Action · reversible
  • Basic auth
  • Panel API · since v21.2.34
  • Hub: needs owner approval
  • restartVpsForwardingService
POST/v2/forwarding/restart_service

Request body application/json · required

namestringrequired

Authentication

Needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.

Responses

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
Could not restart NAMEUnknown service or the restart failed (the service's last error is returned instead when known).Check /v2/forwarding/service_detail.
Failed to restart NAME: ...Unexpected error.Check the controller log.
Verified against XProxy v21.3.2 on Nov 17, 2026