- API Reference
- Box API
- 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.
/statusQuery parameters
Proxy address as HOST:PORT, for example 192.0.2.10:4001. Only the port selects the slot.
192.0.2.10:4001Any 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.
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 |
|---|---|---|
MODEM_RESETTING | A rotation is running on this slot. | Poll again every few seconds. |
MODEM_DISCONNECTED | The slot has no public IP. | Check the modem in the panel. |
MODEM_NOT_FOUND | No slot uses this port. | Use a port from /api/v1/info_list. |
invalid_format_proxy | proxy is missing or not HOST:PORT. | Send proxy=HOST:PORT. |
external_server_error | The external server this host belongs to did not answer within 3 seconds. | Check that server or add internal=1. |