Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

List Available XML/JSON API calls — applist

This function lists all available XML/JSON API functions.

note Note: The output of this function will reflect the permissions of the user. This function will list only the calls available to the username with which you are logged in.

Calling Functions

Using the XML API

To use the XML API to perform the applist function from within your custom script:

  • Append the /xml-api/applist function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/applist

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the applist function from within your custom script:

  • Append the /json-api/applist function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/applist

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

This function call has no input variables.

Output

  • applist — Root-level XML tag for the output of the applist function.
    • app — XML/JSON API function name.

Examples

XML API

Calling this URL in WebHost Manager:

https://example.com:2087/xml-api/applist

will produce output similar to:

<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>

JSON API

Calling this URL in WebHost Manager:

https://example.com:2087/json-api/applist

will produce output similar to:

{
   "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"
   ]
}

note Note: For more information about the listed function calls, see the main list of XML/JSON API functions.

Topic revision: r6 - 29 Sep 2009 - 17:08:59 - MelanieSeibert