- API Reference
- Box API
- Proxies
Check whether a proxy is online by its port number
Use this when you only know the port. Same answer as the status operations; a missing or non-integer port answers HTTP 400 invalid_port.
/status_by_portQuery parameters
HTTP or SOCKS5 port of the proxy.
4001Authentication
Always needs a trusted caller (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) or valid dashboard Basic credentials, which are checked only when dashboard authentication is enabled.
Responses
Slot state.
MODEM_READY — online with a public IP. COLLISION_IP — online, but the new IP equals the previous one (only when duplicate-IP detection is on). MODEM_RESETTING — rotation in progress. MODEM_DISCONNECTED — slot exists but has no public IP (also for an empty slot). MODEM_NOT_FOUND — no slot with that port or position.
MODEM_READY, MODEM_RESETTING, MODEM_DISCONNECTED, MODEM_NOT_FOUND, COLLISION_IPCurrent public IPv4. While a single IP check fails but the modem is still connected, this is the last known IP.
Current public IPv6, empty or null when the slot has none.
Public IPv4 before the latest rotation, null when unknown.
Only for IPv6-multiple slots when IP status reporting is on.
Only for IPv6-multiple slots when IP status reporting is on.
port missing or not an integer.
True when the box accepted the request.
Outcome code or message (see the operation's error table).
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. |
COLLISION_IP | Online, but the public IP equals the previous one (duplicate-IP detection is on); status is true. | Rotate again if a fresh IP is required. |
invalid_port | port is missing or not an integer (HTTP 400). | Send port as an integer such as 4001. |