- API Reference
- Box API
- Overview
Read licence, plan, enabled features and software version of the box
Use this to check which licence features are on (IPv6, VLESS, selling, SMS/USSD, VPS forwarding and so on) before calling a feature route, and to read the installed version and build. Returns secrets and personal data: the licence key, the subscription secret key and the buyer email. Only trusted tools should call it; never log or display the response. If reading the licence fails, the box answers status: false with an empty data.
/system_informationResponses
System information, or status false with empty data on failure.
Licence key of the box (secret).
Subscription secret (secret).
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.