API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Proxies

Check whether a proxy is online (legacy query-string form)

Use this only for existing integrations; new code should use /api/v1/status/proxy/{proxy}, which answers the same. When the host part of proxy is a registered external XProxy server, the box forwards the call to that server unless internal is present. A missing or malformed proxy answers invalid_format_proxy.

  • Read only
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • getLegacyStatus
GET/status

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
internalstringoptional

Any value. Answer from this box even if the host is a registered external server.

Authentication

Open by default: with "Basic auth for all API" (api_auth_check) off, anyone who can reach the box can call it. When it is on, the caller must be trusted (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or send dashboard Basic credentials, which are checked only when dashboard authentication (dashboard_disable_auth off) is enabled.

Responses

Slot state, invalid_format_proxy, or external_server_error when forwarding failed.

Errors returned in msg

msgMeaningWhat to do
MODEM_RESETTINGA rotation is running on this slot.Poll again every few seconds.
MODEM_DISCONNECTEDThe slot has no public IP.Check the modem in the panel.
MODEM_NOT_FOUNDNo slot uses this port.Use a port from /api/v1/info_list.
invalid_format_proxyproxy is missing or not HOST:PORT.Send proxy=HOST:PORT.
external_server_errorThe external server this host belongs to did not answer within 3 seconds.Check that server or add internal=1.
Verified against XProxy v21.3.2 on Nov 17, 2026