Child pages
  • WHM API 0 Functions - loadavg
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the server's load average.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/loadavg
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/loadavg
 Command Line
whmapi0 loadavg


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi0 command:

    /usr/local/cpanel/bin/api/whmapi0

 Output (JSON)
{
   "one":"0.17",
   "five":"0.18",
   "fifteen":"0.19"
}
 Output (XML)
<loadavg>
       <one>0.17</one>
       <five>0.18</five>
       <fifteen>0.19</fifteen>
</loadavg>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
onestring

The server's load average over the previous minute.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.17
fivestringThe server's load average over the previous minute.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.18
fifteenstringThe server's load average over the previous minute.

A decimal number.

For example, a value of .18 represents 18% of a single CPU's processor capacity.

0.19