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

Check whether a proxy is online and read its public IP

Use this to poll a proxy after a rotation until it reports MODEM_READY with the new IP. Looks the slot up by the port in HOST:PORT.

  • Read only
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • getStatusOfProxy
GET/api/v1/status/proxy/{proxy}

Path parameters

proxystringrequired

Proxy address as HOST:PORT. Only the port is used to find the slot; the host part is ignored (any non-empty text without a colon works). Use the HTTP or SOCKS5 port shown in the panel or in /api/v1/info_list.

Example 192.0.2.10:4001

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, or invalid_format_proxy when the path is not HOST:PORT.

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 (offline modem or empty slot).Check the modem in the panel; reboot it if it stays offline.
MODEM_NOT_FOUNDNo slot matches the port or position.Use a port or position from /api/v1/info_list.
COLLISION_IPThe new IP equals the previous one (duplicate-IP detection on).Rotate again if you need a different IP.
invalid_format_proxyThe proxy value is not HOST:PORT.Send it as HOST:PORT, for example 192.0.2.10:4001.
Verified against XProxy v21.3.2 on Nov 17, 2026