- API Reference
- Box API
- 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.
/api/v1/status/proxy/{proxy}Path parameters
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.
192.0.2.10:4001Authentication
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.
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 (offline modem or empty slot). | Check the modem in the panel; reboot it if it stays offline. |
MODEM_NOT_FOUND | No slot matches the port or position. | Use a port or position from /api/v1/info_list. |
COLLISION_IP | The new IP equals the previous one (duplicate-IP detection on). | Rotate again if you need a different IP. |
invalid_format_proxy | The proxy value is not HOST:PORT. | Send it as HOST:PORT, for example 192.0.2.10:4001. |