- API Reference
- Box API
- 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.
/api/min/get-current-proxyQuery parameters
Slot number.
1Proxy users for the slot as user:password pairs in the box's user-list format. Omitted means none.
user1:YOUR_PROXY_PASSWORDClient IPs allowed without a password, comma separated. Omitted means none.
198.51.100.71 to test the proxy through the box's IP checker before answering.
0, 1Example 0Timeout of the proxy test in seconds.
3Example 3Authentication
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.
Got IP successfully., Got IP failed. or Error: followed by the test result.
0, 1, 2position missing or not an integer, or no such slot.
Missing arguments, Not found positionCaller not trusted and no valid credentials.