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

Read CPU, memory, uptime, version and plan of the box

Use this for a quick health and licence overview. memory and cpu are percentages, time is hours since the operating system booted. At most every 15 minutes the call also asks the update server whether a newer version exists and refreshes update_info. Plan fields are present only once the licence module is loaded. Returns the buyer email (personal data).

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

Responses

Resource and plan summary.

statusbooleanoptional
dataobjectoptional
data.memorynumberoptional

Memory use in percent.

data.cpunumberoptional

CPU use in percent.

data.timeintegeroptional

Hours since boot.

data.versionstringoptional
data.is_updatingbooleanoptional
data.update_infoobject | nulloptional
data.update_info.latest_versionstringoptional
data.update_info.headingstringoptional
data.update_info.notestringoptional
data.update_info.need_updatebooleanoptional
data.update_info.is_prodboolean | stringoptional
data.ended_supportbooleanoptional
data.plan_namestringoptional
data.max_modemintegeroptional
data.activatedbooleanoptional
data.plan_starting_datestring | nulloptional
data.plan_ending_datestring | nulloptional
data.plan_remaining_dayinteger | nulloptional
data.is_connected_servicebooleanoptional
data.server_namestringoptional
data.buyer_emailstringoptional
Verified against XProxy v21.3.2 on Nov 17, 2026