- API Reference
- Box API
- 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.
/api/v1/status/position/{position}Path parameters
Slot number (position) on the box, starting at 1. A value that is not an integer makes the box answer HTTP 500.
1Authentication
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.
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.
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.
Unhandled error, for example a non-integer position or a missing required parameter.
Error name, e.g. internal_server_error or bad_request.
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. |