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

 

Description

This function lists available WHM API 1 functions.

Note:

This function only lists the functions 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 1 functions that require root privileges.

Examples 


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

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

 Output (JSON)
{  
   "data":{  
      "app":[  
         "_getpkgextensionform",
         "abort_transfer_session",
         "accesshash",
         "accountsummary",
         "acctcounts",
         "add_configclusterserver",
         "adddns",
         "addips",
         "addpkg",
         "addzonerecord",
         "analyze_transfer_session_remote",
         "applist",
         "authorizesshkey",
         "available_transfer_modules",
         "backup_config_get",
         "backup_config_set",
         "backup_date_list",
         "backup_destination_add",
         "backup_destination_delete",
         "backup_destination_get",
         "backup_destination_list",
         "backup_destination_set",
         "backup_destination_validate",
         "backup_set_list",
         "backup_skip_users_all",
         "backup_skip_users_all_status",
         "backup_user_list",
         "batch",
         "changepackage",
         "check_remote_ssh_connection",
         "configurebackgroundprocesskiller",
         "configureservice",
         "convertopensshtoputty",
         "create_featurelist",
         "create_remote_root_transfer_session",
         "create_remote_user_transfer_session",
         "create_user_session",
         "createacct",
         "delete_configclusterserver",
         "delete_featurelist",
         "delete_hook",
         "delete_rpm_version",
         "deletesshkey",
         "delip",
         "domainuserdata",
         "dumpzone",
         "edit_hook",
         "edit_rpm_version",
         "editpkg",
         "editquota",
         "editzonerecord",
         "emailtrack_search",
         "emailtrack_stats",
         "emailtrack_user_stats",
         "enqueue_transfer_item",
         "exim_configuration_check",
         "fetch_mail_queue",
         "fetch_service_ssl_components",
         "fetch_ssl_vhosts",
         "fetch_transfer_session_log",
         "fetch_vhost_ssl_components",
         "fetchcrtinfo",
         "fetchsslinfo",
         "forcepasswordchange",
         "generatesshkeypair",
         "generatessl",
         "get_appconfig_application_list",
         "get_available_featurelists",
         "get_available_tiers",
         "get_feature_names",
         "get_password_strength",
         "get_remote_access_hash",
         "get_rpm_version_data",
         "get_transfer_session_state",
         "get_tweaksetting",
         "getdiskusage",
         "getfeaturelist",
         "gethostname",
         "getlongtermsupport",
         "getpkginfo",
         "getresellerips",
         "getzonerecord",
         "has_digest_auth",
         "has_mycnf_for_cpuser",
         "importsshkey",
         "install_service_ssl_certificate",
         "installssl",
         "ipv6_disable_account",
         "ipv6_enable_account",
         "ipv6_range_add",
         "ipv6_range_edit",
         "ipv6_range_list",
         "ipv6_range_remove",
         "ipv6_range_usage",
         "is_sni_supported",
         "killdns",
         "killpkg",
         "list_configclusterservers",
         "list_cparchive_files",
         "list_database_users",
         "list_databases",
         "list_hooks",
         "list_rpms",
         "listaccts",
         "listacls",
         "listcrts",
         "listips",
         "listlockedaccounts",
         "listmxs",
         "listpkgs",
         "listresellers",
         "listsshkeys",
         "listsuspended",
         "listzones",
         "load_style",
         "lookupnsip",
         "manage_features",
         "matchpkgs",
         "modifyacct",
         "modsec_add_rule",
         "modsec_assemble_config_text",
         "modsec_batch_settings",
         "modsec_check_rule",
         "modsec_deploy_rule_changes",
         "modsec_deploy_settings_changes",
         "modsec_disable_rule",
         "modsec_discard_rule_changes",
         "modsec_edit_rule",
         "modsec_get_config_text",
         "modsec_get_configs",
         "modsec_get_configs_with_changes_pending",
         "modsec_get_log",
         "modsec_get_rules",
         "modsec_get_settings",
         "modsec_is_installed",
         "modsec_make_config_active",
         "modsec_make_config_inactive",
         "modsec_remove_rule",
         "modsec_remove_setting",
         "modsec_set_config_text",
         "modsec_set_setting",
         "modsec_undisable_rule",
         "myprivs",
         "nat_checkip",
         "nat_set_public_ip",
         "nvget",
         "nvset",
         "passwd",
         "pause_transfer_session",
         "read_featurelist",
         "reboot",
         "rebuildinstalledssldb",
         "rebuilduserssldb",
         "remote_basic_credential_check",
         "remove_in_progress_exim_config_edit",
         "removeacct",
         "removezonerecord",
         "rename_mysql_database",
         "rename_mysql_user",
         "rename_postgresql_database",
         "rename_postgresql_user",
         "reorder_hooks",
         "resellerstats",
         "reset_service_ssl_certificate",
         "resetzone",
         "resolvedomainname",
         "restartservice",
         "restore_queue_activate",
         "restore_queue_add_task",
         "restore_queue_clear_all_completed_tasks",
         "restore_queue_clear_all_failed_tasks",
         "restore_queue_clear_all_pending_tasks",
         "restore_queue_clear_all_tasks",
         "restore_queue_clear_completed_task",
         "restore_queue_clear_pending_task",
         "restore_queue_is_active",
         "restore_queue_list_active",
         "restore_queue_list_completed",
         "restore_queue_list_pending",
         "restore_queue_state",
         "restoreaccount",
         "retrieve_transfer_session_remote_analysis",
         "save_spamd_config",
         "save_style",
         "saveacllist",
         "savemxs",
         "servicestatus",
         "set_cpanel_updates",
         "set_digest_auth",
         "set_mysql_password",
         "set_postgresql_password",
         "set_primary_servername",
         "set_tier",
         "set_tweaksetting",
         "setacls",
         "sethostname",
         "setminimumpasswordstrengths",
         "setresellerips",
         "setresellerlimits",
         "setresellermainip",
         "setresellernameservers",
         "setresellerpackagelimit",
         "setresolvers",
         "setsiteip",
         "setupreseller",
         "showbw",
         "start_transfer_session",
         "suspendacct",
         "suspendreseller",
         "systemloadavg",
         "terminatereseller",
         "ticket_grant",
         "ticket_list",
         "ticket_remove_closed",
         "ticket_revoke",
         "ticket_ssh_test",
         "ticket_whitelist_check",
         "ticket_whitelist_setup",
         "ticket_whitelist_unsetup",
         "toggle_user_backup_state",
         "transfer_module_schema",
         "unsetupreseller",
         "unsuspendacct",
         "unsuspendreseller",
         "update_configclusterserver",
         "update_featurelist",
         "update_updateconf",
         "validate_current_installed_exim_config",
         "validate_exim_configuration_syntax",
         "validate_system_user",
         "version"
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"applist"
   }
}
 Output (XML)
<result>
    <data>
        <app>_getpkgextensionform</app>
        <app>abort_transfer_session</app>
        <app>accesshash</app>
        <app>accountsummary</app>
        <app>acctcounts</app>
        <app>add_configclusterserver</app>
        <app>adddns</app>
        <app>addips</app>
        <app>addpkg</app>
        <app>addzonerecord</app>
        <app>analyze_transfer_session_remote</app>
        <app>applist</app>
        <app>authorizesshkey</app>
        <app>available_transfer_modules</app>
        <app>backup_config_get</app>
        <app>backup_config_set</app>
        <app>backup_date_list</app>
        <app>backup_destination_add</app>
        <app>backup_destination_delete</app>
        <app>backup_destination_get</app>
        <app>backup_destination_list</app>
        <app>backup_destination_set</app>
        <app>backup_destination_validate</app>
        <app>backup_set_list</app>
        <app>backup_skip_users_all</app>
        <app>backup_skip_users_all_status</app>
        <app>backup_user_list</app>
        <app>batch</app>
        <app>changepackage</app>
        <app>check_remote_ssh_connection</app>
        <app>configurebackgroundprocesskiller</app>
        <app>configureservice</app>
        <app>convertopensshtoputty</app>
        <app>create_featurelist</app>
        <app>create_remote_root_transfer_session</app>
        <app>create_remote_user_transfer_session</app>
        <app>create_user_session</app>
        <app>createacct</app>
        <app>delete_configclusterserver</app>
        <app>delete_featurelist</app>
        <app>delete_hook</app>
        <app>delete_rpm_version</app>
        <app>deletesshkey</app>
        <app>delip</app>
        <app>domainuserdata</app>
        <app>dumpzone</app>
        <app>edit_hook</app>
        <app>edit_rpm_version</app>
        <app>editpkg</app>
        <app>editquota</app>
        <app>editzonerecord</app>
        <app>emailtrack_search</app>
        <app>emailtrack_stats</app>
        <app>emailtrack_user_stats</app>
        <app>enqueue_transfer_item</app>
        <app>exim_configuration_check</app>
        <app>fetch_mail_queue</app>
        <app>fetch_service_ssl_components</app>
        <app>fetch_ssl_vhosts</app>
        <app>fetch_transfer_session_log</app>
        <app>fetch_vhost_ssl_components</app>
        <app>fetchcrtinfo</app>
        <app>fetchsslinfo</app>
        <app>forcepasswordchange</app>
        <app>generatesshkeypair</app>
        <app>generatessl</app>
        <app>get_appconfig_application_list</app>
        <app>get_available_featurelists</app>
        <app>get_available_tiers</app>
        <app>get_feature_names</app>
        <app>get_password_strength</app>
        <app>get_remote_access_hash</app>
        <app>get_rpm_version_data</app>
        <app>get_transfer_session_state</app>
        <app>get_tweaksetting</app>
        <app>getdiskusage</app>
        <app>getfeaturelist</app>
        <app>gethostname</app>
        <app>getlongtermsupport</app>
        <app>getpkginfo</app>
        <app>getresellerips</app>
        <app>getzonerecord</app>
        <app>has_digest_auth</app>
        <app>has_mycnf_for_cpuser</app>
        <app>importsshkey</app>
        <app>install_service_ssl_certificate</app>
        <app>installssl</app>
        <app>ipv6_disable_account</app>
        <app>ipv6_enable_account</app>
        <app>ipv6_range_add</app>
        <app>ipv6_range_edit</app>
        <app>ipv6_range_list</app>
        <app>ipv6_range_remove</app>
        <app>ipv6_range_usage</app>
        <app>is_sni_supported</app>
        <app>killdns</app>
        <app>killpkg</app>
        <app>list_configclusterservers</app>
        <app>list_cparchive_files</app>
        <app>list_database_users</app>
        <app>list_databases</app>
        <app>list_hooks</app>
        <app>list_rpms</app>
        <app>listaccts</app>
        <app>listacls</app>
        <app>listcrts</app>
        <app>listips</app>
        <app>listlockedaccounts</app>
        <app>listmxs</app>
        <app>listpkgs</app>
        <app>listresellers</app>
        <app>listsshkeys</app>
        <app>listsuspended</app>
        <app>listzones</app>
        <app>load_style</app>
        <app>lookupnsip</app>
        <app>manage_features</app>
        <app>matchpkgs</app>
        <app>modifyacct</app>
        <app>modsec_add_rule</app>
        <app>modsec_assemble_config_text</app>
        <app>modsec_batch_settings</app>
        <app>modsec_check_rule</app>
        <app>modsec_deploy_rule_changes</app>
        <app>modsec_deploy_settings_changes</app>
        <app>modsec_disable_rule</app>
        <app>modsec_discard_rule_changes</app>
        <app>modsec_edit_rule</app>
        <app>modsec_get_config_text</app>
        <app>modsec_get_configs</app>
        <app>modsec_get_configs_with_changes_pending</app>
        <app>modsec_get_log</app>
        <app>modsec_get_rules</app>
        <app>modsec_get_settings</app>
        <app>modsec_is_installed</app>
        <app>modsec_make_config_active</app>
        <app>modsec_make_config_inactive</app>
        <app>modsec_remove_rule</app>
        <app>modsec_remove_setting</app>
        <app>modsec_set_config_text</app>
        <app>modsec_set_setting</app>
        <app>modsec_undisable_rule</app>
        <app>myprivs</app>
        <app>nat_checkip</app>
        <app>nat_set_public_ip</app>
        <app>nvget</app>
        <app>nvset</app>
        <app>passwd</app>
        <app>pause_transfer_session</app>
        <app>read_featurelist</app>
        <app>reboot</app>
        <app>rebuildinstalledssldb</app>
        <app>rebuilduserssldb</app>
        <app>remote_basic_credential_check</app>
        <app>remove_in_progress_exim_config_edit</app>
        <app>removeacct</app>
        <app>removezonerecord</app>
        <app>rename_mysql_database</app>
        <app>rename_mysql_user</app>
        <app>rename_postgresql_database</app>
        <app>rename_postgresql_user</app>
        <app>reorder_hooks</app>
        <app>resellerstats</app>
        <app>reset_service_ssl_certificate</app>
        <app>resetzone</app>
        <app>resolvedomainname</app>
        <app>restartservice</app>
        <app>restore_queue_activate</app>
        <app>restore_queue_add_task</app>
        <app>restore_queue_clear_all_completed_tasks</app>
        <app>restore_queue_clear_all_failed_tasks</app>
        <app>restore_queue_clear_all_pending_tasks</app>
        <app>restore_queue_clear_all_tasks</app>
        <app>restore_queue_clear_completed_task</app>
        <app>restore_queue_clear_pending_task</app>
        <app>restore_queue_is_active</app>
        <app>restore_queue_list_active</app>
        <app>restore_queue_list_completed</app>
        <app>restore_queue_list_pending</app>
        <app>restore_queue_state</app>
        <app>restoreaccount</app>
        <app>retrieve_transfer_session_remote_analysis</app>
        <app>save_spamd_config</app>
        <app>save_style</app>
        <app>saveacllist</app>
        <app>savemxs</app>
        <app>servicestatus</app>
        <app>set_cpanel_updates</app>
        <app>set_digest_auth</app>
        <app>set_mysql_password</app>
        <app>set_postgresql_password</app>
        <app>set_primary_servername</app>
        <app>set_tier</app>
        <app>set_tweaksetting</app>
        <app>setacls</app>
        <app>sethostname</app>
        <app>setminimumpasswordstrengths</app>
        <app>setresellerips</app>
        <app>setresellerlimits</app>
        <app>setresellermainip</app>
        <app>setresellernameservers</app>
        <app>setresellerpackagelimit</app>
        <app>setresolvers</app>
        <app>setsiteip</app>
        <app>setupreseller</app>
        <app>showbw</app>
        <app>start_transfer_session</app>
        <app>suspendacct</app>
        <app>suspendreseller</app>
        <app>systemloadavg</app>
        <app>terminatereseller</app>
        <app>ticket_grant</app>
        <app>ticket_list</app>
        <app>ticket_remove_closed</app>
        <app>ticket_revoke</app>
        <app>ticket_ssh_test</app>
        <app>ticket_whitelist_check</app>
        <app>ticket_whitelist_setup</app>
        <app>ticket_whitelist_unsetup</app>
        <app>toggle_user_backup_state</app>
        <app>transfer_module_schema</app>
        <app>unsetupreseller</app>
        <app>unsuspendacct</app>
        <app>unsuspendreseller</app>
        <app>update_configclusterserver</app>
        <app>update_featurelist</app>
        <app>update_updateconf</app>
        <app>validate_current_installed_exim_config</app>
        <app>validate_exim_configuration_syntax</app>
        <app>validate_system_user</app>
        <app>version</app>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>applist</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

app

array

An array of available function names.

An array of valid strings.accountsummary