- API Reference
- Box API
- VPS forwarding
Inspect one forwarding service with its events, logs and diagnosed cause
Returns the service row, its last error, recent VPS events, box and VPS log lines and a diagnosed cause and hint. Reads logs over SSH, so it can take some seconds.
/v2/forwarding/service_detailQuery parameters
Service name from /v2/forwarding/get_mapping_ports.
xlocal@4001Authentication
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
Service detail, or a refusal.
Unit name, e.g. xlocal@4001 or xwg@20000.
e.g. running, starting, relay_down.
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 |
|---|---|---|
Service NAME not found | No service has this name. | Take the name from /v2/forwarding/get_mapping_ports. |
Failed to inspect NAME: ... | Reading the logs failed (for example the VPS is unreachable). | Check /v2/forwarding/vps_health. |