We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function lists registered AppConfig applications.

Examples 


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


Notes:

  • Unless otherwise noted, 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":{
      "whostmgr":[
         {
            "acls":[
               "all"
            ],
            "url":"/cgi/api_shell/index.cgi",
            "user":"root",
            "name":"internal_apishell"
         },
         {
            "url":"/cgi/securityadvisor/index.cgi",
            "acls":[
               "all"
            ],
            "name":"internal_securityadvisor",
            "user":"root"
         },
         {
            "acls":[
               "all"
            ],
            "url":"/3rdparty/phpMyAdmin",
            "user":"cpanelphpmyadmin",
            "phpConfig":"phpmyadmin",
            "name":"internal_phpmyadmin"
         },
         {
            "acls":[
               "all"
            ],
            "url":[
               "/cgi/cpaddons.pl",
               "/cgi/cpaddons_report.pl"
            ],
            "name":"internal_cpaddons_root",
            "user":"root"
         },
         {
            "acls":[
               "all"
            ],
            "url":[
               "/cgi/adjustclusterdns.cgi",
               "/cgi/adjustclusteroptions.cgi"
            ],
            "name":"internal_dnsclustering_root",
            "user":"root"
         },
         {
            "name":"internal_cloudlinux",
            "user":"root",
            "url":"/cgi/CloudLinux.cgi",
            "acls":[
               "all"
            ]
         },
         {
            "url":"/cgi/diskusage.cgi",
            "acls":[
               "all"
            ],
            "user":"root",
            "name":"internal_diskusage"
         },
         {
            "acls":[
               "all"
            ],
            "url":[
               "/cgi/mailflow.cgi",
               "/cgi/addrbl.cgi"
            ],
            "user":"root",
            "name":"internal_eximconfig"
         },
         {
            "url":"/cgi/statmanager.cgi",
            "acls":[
               "all"
            ],
            "name":"internal_stats",
            "user":"root"
         },
         {
            "acls":[
               "all"
            ],
            "url":"/cgi/hostaccess.cgi",
            "user":"root",
            "name":"internal_hostaccess"
         },
         {
            "url":[
               "/cgi/cpanel_log_rotation.pl",
               "/cgi/apache_log_rotation.pl"
            ],
            "acls":[
               "all"
            ],
            "user":"root",
            "name":"internal_logrotation"
         },
         {
            "user":"root",
            "name":"internal_cphulkd",
            "url":[
               "/cgi/tweakcphulk.cgi",
               "/cgi/cphulkdblk.cgi",
               "/cgi/cphulkdwhitelist.cgi",
               "/cgi/bl.cgi",
               "/cgi/wl.cgi"
            ],
            "acls":[
               "all"
            ]
         },
         {
            "name":"queued_session_system",
            "user":"root",
            "url":[
               "/cgi/live_tail_log",
               "/cgi/live_tail_transfer_log.cgi"
            ],
            "acls":[
               "rearrange-accts"
            ]
         },
         {
            "url":[
               "/cgi/sshcheck.cgi"
            ],
            "acls":[
               "all"
            ],
            "user":"root",
            "name":"internal_transfers"
         },
         {
            "user":"root",
            "name":"process_tail",
            "url":[
               "/cgi/process_tail.cgi"
            ],
            "acls":[
               "all"
            ]
         },
         {
            "user":"root",
            "name":"internal_compat",
            "acls":[
               "all"
            ],
            "url":"/cgi/parseform.pl"
         },
         {
            "name":"internal_ssh_key_manage",
            "user":"root",
            "url":"/backend/puttykey.cgi",
            "acls":[
               "all"
            ]
         },
         {
            "url":[
               "/cgi/activate_remote_nameservers.cgi",
               "/cgi/adjustuniquedns.cgi",
               "/cgi/configure_remote_nameserver.cgi",
               "/cgi/enableclusterserver.cgi",
               "/cgi/clusterstatus.cgi",
               "/cgi/remclusterserver.cgi",
               "/cgi/changeclusterdns.cgi",
               "/cgi/trustclustermaster.cgi"
            ],
            "acls":[
               "clustering"
            ],
            "name":"internal_dns_clustering",
            "user":"root"
         },
         {
            "acls":[
               "locale-edit"
            ],
            "url":[
               "/cgi/ajax_maketext_syntax_util.pl",
               "/cgi/ajax_locale_delete_local_key.pl",
               "/cgi/build_locale_databases.pl",
               "/cgi/locale_duplicate.cgi"
            ],
            "name":"internal_locale",
            "user":"root"
         },
         {
            "acls":[
               "mailcheck"
            ],
            "url":"/cgi/traceaddy.cgi",
            "name":"internal_mail_troubleshooter",
            "user":"root"
         },
         {
            "url":[
               "/cgi/zoneeditor.cgi.pl",
               "/cgi/zoneeditor.cgi"
            ],
            "acls":[
               "edit-dns"
            ],
            "name":"internal_zoneeditor",
            "user":"root"
         },
         {
            "user":"root",
            "name":"internal_changelog",
            "acls":[
               "any"
            ],
            "url":"/cgi/changelog.cgi"
         },
         {
            "url":"/cgi/brandingimage.cgi",
            "acls":[
               "any"
            ],
            "name":"internal_branding",
            "user":"root"
         },
         {
            "url":[
               "/backend/passwordstrength.cgi",
               "/cgi/passwordstrength.cgi"
            ],
            "acls":[
               "any"
            ],
            "user":"root",
            "name":"internal_passwordstrength"
         },
         {
            "user":"root",
            "name":"internal_newsfeed",
            "acls":[
               "any"
            ],
            "url":"/cgi/news.cgi"
         },
         {
            "url":"/styled/",
            "acls":[
               "any"
            ],
            "user":"$authuser",
            "name":"internal_styled"
         },
         {
            "displayname":"Munin Service Monitor",
            "name":"munin_addon",
            "target":"_blank",
            "user":"root",
            "origin":"munin_addon.conf",
            "acls":[
               "all"
            ],
            "url":[
               "/cgi/addon_munin.cgi",
               "/munin/"
            ],
            "entryurl":"addon_munin.cgi"
         },
         {
            "displayname":"Configure ClamAV Scanner",
            "name":"clamavconnector",
            "target":"_self",
            "url":[
               "/cgi/addon_clamavconnector.cgi"
            ],
            "acls":[
               "all"
            ],
            "entryurl":"addon_clamavconnector.cgi",
            "user":"root",
            "origin":"clamavconnector.conf"
         },
         {
            "icon":"imunify-antivirus-logo.png",
            "target":"_self",
            "name":"imunify-antivirus",
            "displayname":"ImunifyAV",
            "entryurl":"imunify/handlers/index.cgi",
            "url":[
               "/cgi/imunify"
            ],
            "acls":[
               "all"
            ],
            "user":"root",
            "origin":"imunify-antivirus.conf"
         }
      ],
      "cpanel":[
         {
            "url":"/3rdparty/mailman/",
            "features":[
               "lists"
            ],
            "name":"mailman",
            "group":"mailman",
            "user":"mailman"
         },
         {
            "url":"/3rdparty/roundcube/",
            "name":"roundcube",
            "features":[
               "webmail"
            ],
            "user":"cpanelroundcube",
            "phpConfig":"roundcube"
         },
         {
            "url":"/3rdparty/phpPgAdmin",
            "features":[
               "phppgadmin"
            ],
            "name":"phppgadmin",
            "user":"cpanelphppgadmin",
            "phpConfig":"phppgadmin"
         },
         {
            "name":"internal_elfinder_connector",
            "features":[
               "filemanager"
            ],
            "url":[
               "/backend/elfinder_connector.cgi",
               "/cgi/elfinder_connector.cgi"
            ]
         },
         {
            "name":"phpmyadmin",
            "features":[
               "phpmyadmin"
            ],
            "url":"/3rdparty/phpMyAdmin"
         },
         {
            "name":"gitweb",
            "features":[
               "version_control"
            ],
            "url":"/3rdparty/gitweb/"
         },
         {
            "url":"/awstats.pl",
            "demo":0,
            "name":"awstats",
            "features":[
               "awstats"
            ]
         }
      ],
      "webmail":[
         {
            "phpConfig":"horde",
            "features":[
               "webmail"
            ],
            "name":"horde",
            "url":"/horde/"
         },
         {
            "url":"/3rdparty/roundcube/",
            "features":[
               "webmail"
            ],
            "name":"roundcube",
            "user":"cpanelroundcube",
            "phpConfig":"roundcube"
         },
         {
            "url":"/3rdparty/mailman/",
            "features":[
               "lists"
            ],
            "name":"mailman",
            "user":"mailman",
            "group":"mailman"
         }
      ]
   },
   "metadata":{
      "result":1,
      "command":"get_appconfig_application_list",
      "version":1,
      "reason":"Got application list"
   }
}
 Output (XML)
<result>
   <data>
      <cpanel>
         <element>
            <features>
               <element>lists</element>
            </features>
            <group>mailman</group>
            <name>mailman</name>
            <url>/3rdparty/mailman/</url>
            <user>mailman</user>
         </element>
         <element>
            <features>
               <element>webmail</element>
            </features>
            <name>roundcube</name>
            <phpConfig>roundcube</phpConfig>
            <url>/3rdparty/roundcube/</url>
            <user>cpanelroundcube</user>
         </element>
         <element>
            <features>
               <element>phppgadmin</element>
            </features>
            <name>phppgadmin</name>
            <phpConfig>phppgadmin</phpConfig>
            <url>/3rdparty/phpPgAdmin</url>
            <user>cpanelphppgadmin</user>
         </element>
         <element>
            <features>
               <element>filemanager</element>
            </features>
            <name>internal_elfinder_connector</name>
            <url>
               <element>/backend/elfinder_connector.cgi</element>
               <element>/cgi/elfinder_connector.cgi</element>
            </url>
         </element>
         <element>
            <features>
               <element>phpmyadmin</element>
            </features>
            <name>phpmyadmin</name>
            <url>/3rdparty/phpMyAdmin</url>
         </element>
         <element>
            <features>
               <element>version_control</element>
            </features>
            <name>gitweb</name>
            <url>/3rdparty/gitweb/</url>
         </element>
         <element>
            <demo>0</demo>
            <features>
               <element>awstats</element>
            </features>
            <name>awstats</name>
            <url>/awstats.pl</url>
         </element>
      </cpanel>
      <webmail>
         <element>
            <features>
               <element>webmail</element>
            </features>
            <name>horde</name>
            <phpConfig>horde</phpConfig>
            <url>/horde/</url>
         </element>
         <element>
            <features>
               <element>webmail</element>
            </features>
            <name>roundcube</name>
            <phpConfig>roundcube</phpConfig>
            <url>/3rdparty/roundcube/</url>
            <user>cpanelroundcube</user>
         </element>
         <element>
            <features>
               <element>lists</element>
            </features>
            <group>mailman</group>
            <name>mailman</name>
            <url>/3rdparty/mailman/</url>
            <user>mailman</user>
         </element>
      </webmail>
      <whostmgr>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_apishell</name>
            <url>/cgi/api_shell/index.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_securityadvisor</name>
            <url>/cgi/securityadvisor/index.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_phpmyadmin</name>
            <phpConfig>phpmyadmin</phpConfig>
            <url>/3rdparty/phpMyAdmin</url>
            <user>cpanelphpmyadmin</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_cpaddons_root</name>
            <url>
               <element>/cgi/cpaddons.pl</element>
               <element>/cgi/cpaddons_report.pl</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_dnsclustering_root</name>
            <url>
               <element>/cgi/adjustclusterdns.cgi</element>
               <element>/cgi/adjustclusteroptions.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_cloudlinux</name>
            <url>/cgi/CloudLinux.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_diskusage</name>
            <url>/cgi/diskusage.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_eximconfig</name>
            <url>
               <element>/cgi/mailflow.cgi</element>
               <element>/cgi/addrbl.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_stats</name>
            <url>/cgi/statmanager.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_hostaccess</name>
            <url>/cgi/hostaccess.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_logrotation</name>
            <url>
               <element>/cgi/cpanel_log_rotation.pl</element>
               <element>/cgi/apache_log_rotation.pl</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_cphulkd</name>
            <url>
               <element>/cgi/tweakcphulk.cgi</element>
               <element>/cgi/cphulkdblk.cgi</element>
               <element>/cgi/cphulkdwhitelist.cgi</element>
               <element>/cgi/bl.cgi</element>
               <element>/cgi/wl.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>rearrange-accts</element>
            </acls>
            <name>queued_session_system</name>
            <url>
               <element>/cgi/live_tail_log</element>
               <element>/cgi/live_tail_transfer_log.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_transfers</name>
            <url>
               <element>/cgi/sshcheck.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>process_tail</name>
            <url>
               <element>/cgi/process_tail.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_compat</name>
            <url>/cgi/parseform.pl</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <name>internal_ssh_key_manage</name>
            <url>/backend/puttykey.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>clustering</element>
            </acls>
            <name>internal_dns_clustering</name>
            <url>
               <element>/cgi/activate_remote_nameservers.cgi</element>
               <element>/cgi/adjustuniquedns.cgi</element>
               <element>/cgi/configure_remote_nameserver.cgi</element>
               <element>/cgi/enableclusterserver.cgi</element>
               <element>/cgi/clusterstatus.cgi</element>
               <element>/cgi/remclusterserver.cgi</element>
               <element>/cgi/changeclusterdns.cgi</element>
               <element>/cgi/trustclustermaster.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>locale-edit</element>
            </acls>
            <name>internal_locale</name>
            <url>
               <element>/cgi/ajax_maketext_syntax_util.pl</element>
               <element>/cgi/ajax_locale_delete_local_key.pl</element>
               <element>/cgi/build_locale_databases.pl</element>
               <element>/cgi/locale_duplicate.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>mailcheck</element>
            </acls>
            <name>internal_mail_troubleshooter</name>
            <url>/cgi/traceaddy.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>edit-dns</element>
            </acls>
            <name>internal_zoneeditor</name>
            <url>
               <element>/cgi/zoneeditor.cgi.pl</element>
               <element>/cgi/zoneeditor.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>any</element>
            </acls>
            <name>internal_changelog</name>
            <url>/cgi/changelog.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>any</element>
            </acls>
            <name>internal_branding</name>
            <url>/cgi/brandingimage.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>any</element>
            </acls>
            <name>internal_passwordstrength</name>
            <url>
               <element>/backend/passwordstrength.cgi</element>
               <element>/cgi/passwordstrength.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>any</element>
            </acls>
            <name>internal_newsfeed</name>
            <url>/cgi/news.cgi</url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>any</element>
            </acls>
            <name>internal_styled</name>
            <url>/styled/</url>
            <user>$authuser</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <displayname>Munin Service Monitor</displayname>
            <entryurl>addon_munin.cgi</entryurl>
            <name>munin_addon</name>
            <origin>munin_addon.conf</origin>
            <target>_blank</target>
            <url>
               <element>/cgi/addon_munin.cgi</element>
               <element>/munin/</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <displayname>Configure ClamAV Scanner</displayname>
            <entryurl>addon_clamavconnector.cgi</entryurl>
            <name>clamavconnector</name>
            <origin>clamavconnector.conf</origin>
            <target>_self</target>
            <url>
               <element>/cgi/addon_clamavconnector.cgi</element>
            </url>
            <user>root</user>
         </element>
         <element>
            <acls>
               <element>all</element>
            </acls>
            <displayname>ImunifyAV</displayname>
            <entryurl>imunify/handlers/index.cgi</entryurl>
            <icon>imunify-antivirus-logo.png</icon>
            <name>imunify-antivirus</name>
            <origin>imunify-antivirus.conf</origin>
            <target>_self</target>
            <url>
               <element>/cgi/imunify</element>
            </url>
            <user>root</user>
         </element>
      </whostmgr>
   </data>
   <metadata>
      <command>get_appconfig_application_list</command>
      <reason>Got application list</reason>
      <result>1</result>
      <version>1</version>
   </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
service_namearray of hashes

An array of hashes of the application's values.

Note:

The service name is the return's name.

This hash includes the name, user, url, phpConfig, groupupgradecall, icon, displayname, origin, target, and entryurl returns, and the acls and features arrays.


acls

array

The ACL(s) with permission to run the application.

The function returns this array in the service_name hash.

A list of valid strings.
any

name

string

The application's name.

The function returns this value in the service_name hash.

A valid string.
roundcube

user

string

The application's username.

The function returns this value in the service_name hash.

A valid username.
roundcube

url

string

The application's URL path.

The function returns this value in the service_name hash.

A valid filepath.
/3rdparty/roundcube

phpConfig

string

The application's php.ini file.

The function returns this value in the service_name hash.

A valid filepath, relative to the /usr/local/cpanel/3rdparty/etc/ directory.
roundcube

group 

string

The application's group.

The function returns this value in the service_name hash.

A valid group name.mailman 

upgradecall

string

The path to the application's upgrade script.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid absolute filepath.

Note:

The system passes upgrade information in the following format: /usr/local/youraddon/bin/upgrade 11.36.0.0 11.38.0.0+

/usr/local/roundcube/bin/upgrade

icon

string

The application's icon file.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid filename.

Note:

Icon files exist in the /usr/local/cpanel/whostmgr/docroot/addon_plugins/ directory.
roundcube.ico

displayname

string

The application's WHM display label.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid string.Roundcube

origin 

string

The application's configuration file.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid configuration file.

clamavconnector.conf

target 

string

The action's target directory.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid directory._self

entryurl

string

The application's WHM entry path.

Note:

The function only returns this value for plugins that you register with AppConfig.

The function returns this value in the service_name hash.

A valid filepath.
roundcube/

features

array

The required features to run the application.

The function returns this array in the service_name hash.

A list of valid strings.
roundcube