API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Token links

Check a proxy's status with its per-port token link

Use this to give an end user a status link for one proxy without sharing the dashboard login. Works only while per-port authentication (port_auth_config) is on. The token must belong to the port in proxy. The answer is the same as /status.

  • Read only
  • Port token in the URL
  • Public API · since v20.8.0
  • Hub: blocked by the Hub
  • getStatusWithPortToken
GET/{token}/status

Path parameters

tokenstringrequiredsecret

Per-port token of the proxy, shown in the panel when per-port authentication is on. Treat it like a password: anyone with the link can use it.

Query parameters

proxystringrequired

Proxy address as HOST:PORT, for example 192.0.2.10:4001. Only the port selects the slot.

Example 192.0.2.10:4001

Authentication

Authenticated only by the token in the path; the dashboard login and "Basic auth for all API" do not apply. Refusals answer HTTP 401 with a message.

Responses

Slot state.

Errors returned in msg

msgMeaningWhat to do
Not support!Per-port authentication is off on this box.Turn on per-port authentication in the proxy settings.
Unauthorized!The token does not match this port.Copy the link again from the panel.
Verified against XProxy v21.3.2 on Nov 17, 2026