- API Reference
- Box API
- 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.
POST
/v2/forwarding/restart_serviceRequest 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).
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What to do |
|---|---|---|
Could not restart NAME | Unknown 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. |