- API Reference
- Box API
- Overview
List every slot with ports, IP state, schedules and Smart IP Guard data
Use this for the full panel view of all slots, including offline and stopped ones (unlike /api/v1/info_list, which lists only connected slots). Paging is 1-based; limit 0 returns every row. search filters rows by text match before paging; total counts the filtered rows. Returns secrets: each row carries the slot's VLESS id and Shadowsocks password.
/v2/proxy_listQuery parameters
Page number starting at 1. A non-integer value fails with HTTP 500.
1Example 1Rows per page; 0 returns all rows.
10Example 10Free-text filter on the slot fields (port, IP, label, modem type).
Authentication
Needs the panel login; the API policy additionally requires credentials or a trusted caller (loopback, LAN, whitelist, allowed Tailscale).
Responses
Slots on the requested page.
Slot number, starting at 1.
VLESS client id of the slot (secret). Present only when the slot has a VLESS port.
Shadowsocks password of the slot (secret); null when Shadowsocks is off or not licensed.
Current public IPv4; null when offline or stopped.
Modem type, for example HW-Hilink, QMI, XH22 or Android.
Computed connection state of the slot.
empty, stopped, rotating, disconnected, duplicate, connectedModem details; apn is reduced to the APN name and Wi-Fi/IMEI data is removed.
Number of scheduled rotation jobs on the slot.
Epoch seconds of the next scheduled rotation.
Smart IP Guard score of the current IP (0-100). Present when the guard exists.
True when the slot was auto-stopped or stopped by the user.
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.