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

List every slot with its ports, public IP and access settings

Use this from a reseller panel to see all slots, including empty ones. status is connected when the slot has a public IPv4 or IPv6, disconnected when a modem is present without IP, and unplugged when no modem is detected.

  • Read only
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • minGetListPosition
GET/api/min/get-list-position

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. "Basic auth for all API" does not change this route.

Responses

One entry per slot.

[].systemstringoptional

Box address.

[].positionintegeroptional
[].proxy_portintegeroptional
[].proxy_port_ipv6integer | nulloptional
[].sock_portintegeroptional
[].sock_port_ipv6integer | nulloptional
[].vless_portinteger | nulloptional
[].ss_portinteger | nulloptional
[].public_ipstring | nulloptional
[].public_ip_ipv6string | nulloptional
[].statusstringoptional
One of connected, disconnected, unplugged
[].authentication_usersany[]optional

Proxy users of the slot.

[].authorization_ipsstring | nulloptional

Whitelisted client IPs of the slot.

Verified against XProxy v21.3.2 on Nov 17, 2026