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

Read a slot's proxy and set its users and whitelist in one call

Use this from a reseller panel to hand a slot to a customer. Returns the slot's ports and public IP. If authentication_users or authorization_ips differ from the slot's current values, the box first replaces the slot's proxy users and IP whitelist with the given ones (an omitted parameter counts as empty and clears it). code is 1 on success, 2 when check_proxy=1 and the live proxy test failed, 0 when the slot has no public IP or the update failed.

  • Destructive · confirm first
  • Basic auth when API auth is on
  • Public API · since v20.8.0
  • Hub: needs owner approval
  • minGetCurrentProxy
GET/api/min/get-current-proxy

Query parameters

positionintegerrequired

Slot number.

Example 1
authentication_usersstringoptional

Proxy users for the slot as user:password pairs in the box's user-list format. Omitted means none.

Example user1:YOUR_PROXY_PASSWORD
authorization_ipsstringoptional

Client IPs allowed without a password, comma separated. Omitted means none.

Example 198.51.100.7
check_proxyintegeroptional

1 to test the proxy through the box's IP checker before answering.

One of 0, 1Example 0
check_proxy_timedoutintegeroptional

Timeout of the proxy test in seconds.

Default 3Example 3

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

Slot details and result code.

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

Got IP successfully., Got IP failed. or Error: followed by the test result.

codeintegeroptional
One of 0, 1, 2
authentication_usersstring | nulloptional
authorization_ipsstring | nulloptional
Verified against XProxy v21.3.2 on Nov 17, 2026