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

Check whether a slot is online and read its public IP

Use this to poll a slot by its number after a rotation. An empty slot answers MODEM_DISCONNECTED; a number above the box's slot count answers MODEM_NOT_FOUND.

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

Path parameters

positionintegerrequired

Slot number (position) on the box, starting at 1. A value that is not an integer makes the box answer HTTP 500.

Example 1

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.

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 (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