Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the available WHM API 0 functions.

Note:

This function will only list the function calls that are available to the current user. For example, if the authenticated user is a reseller without root-level privileges, the function will not list WHM API 0 functions that require root privileges.

Examples 


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

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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "app":[
      "accountsummary",
      "adddns",
      "addip",
      "addpkg",
      "addzonerecord",
      "applist",
      "changepackage",
      "cpanel",
      "createacct",
      "delip",
      "dumpzone",
      "editpkg",
      "editzonerecord",
      "fetchsslinfo",
      "generatessl",
      "gethostname",
      "getlanglist",
      "getzonerecord",
      "installssl",
      "killdns",
      "killpkg",
      "limitbw",
      "listaccts",
      "listacls",
      "listcrts",
      "listips",
      "listpkgs",
      "listresellers",
      "listsuspended",
      "listzones",
      "loadavg",
      "lookupnsip",
      "modifyacct",
      "myprivs",
      "nvget",
      "nvset",
      "passwd",
      "reboot",
      "removeacct",
      "resellerstats",
      "restartservice",
      "saveacllist",
      "setacls",
      "sethostname",
      "setresellerips",
      "setresellerlimits",
      "setresellermainip",
      "setresellerpackagelimit",
      "setresolvers",
      "setupreseller",
      "showbw",
      "suspendacct",
      "suspendreseller",
      "terminatereseller",
      "unsetupreseller",
      "unsuspendacct",
      "version"
   ]
}
 Output (XML)
<applist>
        <app>accountsummary</app>
        <app>adddns</app>
        <app>addip</app>
        <app>addpkg</app>
        <app>addzonerecord</app>
        <app>applist</app>
        <app>changepackage</app>        
        <app>cpanel</app>        
        <app>createacct</app>        
        <app>delip</app>
        <app>dumpzone</app>
        <app>editpkg</app>     
        <app>editzonerecord</app>
        <app>fetchsslinfo</app>        
        <app>generatessl</app>        
        <app>gethostname</app>       
        <app>getlanglist</app>
        <app>getzonerecord</app>
        <app>installssl</app>
        <app>killdns</app>
        <app>killpkg</app>        
        <app>limitbw</app>
        <app>listaccts</app>        
        <app>listacls</app>        
        <app>listcrts</app>        
        <app>listpkgs</app>        
        <app>listresellers</app>        
        <app>listsuspended</app>        
        <app>listzones</app>
        <app>loadavg</app>
        <app>lookupnsip</app>
        <app>modifyacct</app>
        <app>myprivs</app>
        <app>nvget</app>
        <app>nvset</app>
        <app>passwd</app>        
        <app>reboot</app>        
        <app>removeacct</app>        
        <app>resellerstats</app>        
        <app>restartservice</app>        
        <app>saveacllist</app>        
        <app>setacls</app>    
        <app>sethostname</app>
        <app>setresellerips</app>
        <app>setresellerlimits</app>
        <app>setresellermainip</app>
        <app>setresellerpackagelimit</app>
        <app>setresolvers</app>
        <app>setupreseller</app>
        <app>showbw</app>        
        <app>suspendacct</app>    
        <app>setresellerips</app>
        <app>suspendreseller</app>
        <app>terminatereseller</app>        
        <app>unsetupreseller</app>        
        <app>unsuspendacct</app>
        <app>version</app>
</applist>

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
applistarray

An array of function namess.

The name of a WHM API 0 function.accountsummary