API Reference
Dashboard
  1. API Reference
  2. Box API
  3. 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.

  • Read only
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • getSystemInformation
GET/system_information

Responses

System information, or status false with empty data on failure.

statusbooleanoptional
dataobjectoptional
data.license_keystringoptional

Licence key of the box (secret).

data.country_codestring | nulloptional
data.max_modemintegeroptional
data.ipv6booleanoptional
data.phonebooleanoptional
data.rotation_ipbooleanoptional
data.vpn_supportbooleanoptional
data.tcposbooleanoptional
data.ip_authenbooleanoptional
data.blacklist_controlbooleanoptional
data.sellingbooleanoptional
data.sms_ussdbooleanoptional
data.vpn_proxybooleanoptional
data.vps_forwarding_portbooleanoptional
data.proxy_groupbooleanoptional
data.vlessbooleanoptional
data.wan_proxybooleanoptional
data.server_namestringoptional
data.buyer_emailstringoptional
data.plan_namestringoptional
data.sub_typestring | nulloptional
data.plan_starting_datestring | nulloptional
data.plan_ending_datestring | nulloptional
data.plan_remaining_dayinteger | nulloptional
data.sub_secret_keystring | nulloptional

Subscription secret (secret).

data.activatedbooleanoptional
data.activated_datestring | nulloptional
data.warrantystring | nulloptional
data.ended_supportbooleanoptional
data.ended_support_datestring | nulloptional
data.your_versionstringoptional
data.build_versionstringoptional
data.git_commitstringoptional
data.install_branchstringoptional
data.update_infoobject | nulloptional
data.is_connected_servicebooleanoptional
data.history_versionsobject[]optional
Verified against XProxy v21.3.2 on Nov 17, 2026