API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

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

Query parameters

portintegerrequired

HTTP or SOCKS5 port of the proxy.

Example 4001

Authentication

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.

statusbooleanrequired
msgstringrequired

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.

One of MODEM_READY, MODEM_RESETTING, MODEM_DISCONNECTED, MODEM_NOT_FOUND, COLLISION_IP
public_ipstringoptional

Current public IPv4. While a single IP check fails but the modem is still connected, this is the last known IP.

public_ip_v6string | nulloptional

Current public IPv6, empty or null when the slot has none.

last_public_ipstring | nulloptional

Public IPv4 before the latest rotation, null when unknown.

ipv4string | nulloptional

Only for IPv6-multiple slots when IP status reporting is on.

ipv6string | nulloptional

Only for IPv6-multiple slots when IP status reporting is on.

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.
COLLISION_IPOnline, 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_portport is missing or not an integer (HTTP 400).Send port as an integer such as 4001.
Verified against XProxy v21.3.2 on Nov 17, 2026