Child pages
  • WHM API 1 Functions - systemloadavg
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves the system's load average.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/systemloadavg?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/systemloadavg?api.version=1
 Command Line
whmapi1 systemloadavg


Notes:

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

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
      "data":{
         "one":"0.17",
         "five":"0.18",
         "fifteen":"0.19"
      },
      "metadata":{
         "result":1,
         "reason":"OK",
         "version":1,
         "command":"systemloadavg"
      }
   }
 Output (XML)
<result>
   <data>
      <one>0.17</one>
      <five>0.18</five>
      <fifteen>0.19</fifteen>
   </data>
   <metadata>
      <result>1</result>
      <reason>OK</reason>
      <version>1</version>
      <command>systemloadavg</command>
   </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

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 five minutes.

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 fifteen minutes.

A decimal number.

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

0.19