Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

restore_modules_summary

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

verify_new_username_for_restore


accountsummary

applist

createacct

domainuserdata

editquota

forcepasswordchange

get_disk_usage

get_domain_info

getdomainowner

has_digest_auth

has_mycnf_for_cpuser

limitbw

list_users

listaccts

listlockedaccounts

listsuspended

modifyacct

myprivs

passwd

quota_enabled

removeacct

set_digest_auth

showbw

suspendacct

unsuspendacct

untrack_acct_id

verify_new_username


convert_addon_fetch_conversion_details

convert_addon_fetch_domain_details

convert_addon_get_conversion_status

convert_addon_initiate_conversion

convert_addon_list_addon_domains

convert_addon_list_conversions


api_token_create

api_token_list

api_token_revoke

api_token_update

disable_authentication_provider

disable_failing_authentication_providers

enable_authentication_provider

get_available_authentication_providers

get_login_url

get_provider_client_configurations

get_provider_configuration_fields

get_provider_display_configurations

get_users_authn_linked_accounts

link_user_authn_provider

set_provider_client_configurations

set_provider_display_configurations

twofactorauth_disable_policy

twofactorauth_enable_policy

twofactorauth_generate_tfa_config

twofactorauth_get_issuer

twofactorauth_get_user_configs

twofactorauth_policy_status

twofactorauth_remove_user_config

twofactorauth_set_issuer

twofactorauth_set_tfa_config

unlink_user_authn_provider

validate_login_token


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_get_transport_status

backup_list_transported

backup_set_list

backup_set_list_combined

backup_skip_users_all

backup_skip_users_all_status

backup_user_list

convert_and_migrate_from_legacy_config

get_users_with_backup_metadata

list_cparchive_files

start_background_pkgacct

toggle_user_backup_state


cphulk_status

create_cphulk_record

delete_cphulk_record

disable_cphulk

enable_cphulk

flush_cphulk_login_history

flush_cphulk_login_history_for_ips

get_countries_with_known_ip_ranges

get_cphulk_brutes

get_cphulk_excessive_brutes

get_cphulk_failed_logins

get_cphulk_user_brutes

load_cphulk_config

read_cphulk_records

save_cphulk_config

set_cphulk_config_key


background_mysql_upgrade_status

current_mysql_version

installable_mysql_versions

latest_available_mysql_version

list_database_users

list_databases

list_mysql_databases_and_users

remote_mysql_create_profile

remote_mysql_create_profile_via_ssh

remote_mysql_delete_profile

remote_mysql_initiate_profile_activation

remote_mysql_monitor_profile_activation

remote_mysql_read_profile  

remote_mysql_read_profiles

remote_mysql_update_profile

remote_mysql_validate_profile

rename_mysql_database

rename_mysql_user

rename_postgresql_database

rename_postgresql_user

set_local_mysql_root_password

set_mysql_password

set_postgresql_password

start_background_mysql_upgrade


adddns

addzonerecord

addzonerecord (Reverse DNS)

dumpzone

editzonerecord

get_nameserver_config

getzonerecord

has_local_authority

killdns

listmxs

listzones

lookupnsip

lookupnsips

removezonerecord

resetzone

resolvedomainname

savemxs

setresolvers

update_nameservers_config


ea4_get_currently_installed_packages

ea4_get_ea_pkgs_state

ea4_list_profiles

ea4_metainfo

ea4_migration

ea4_pre_migrate_check

ea4_recommendations

ea4_save_profile

ea4_tomcat85_add

ea4_tomcat85_list

ea4_tomcat85_rem


cpgreylist_is_server_netblock_trusted

cpgreylist_list_entries_for_common_mail_provider

cpgreylist_load_common_mail_providers_config

cpgreylist_save_common_mail_providers_config

cpgreylist_status

cpgreylist_trust_entries_for_common_mail_provider

cpgreylist_untrust_entries_for_common_mail_provider

create_cpgreylist_trusted_host

delete_cpgreylist_trusted_host

disable_cpgreylist

enable_cpgreylist

load_cpgreylist_config

read_cpgreylist_deferred_entries

read_cpgreylist_trusted_host

save_cpgreylist_config


batch

cpanel

create_integration_group

create_integration_link

get_integration_link_user_config

list_integration_groups

list_integration_links

remove_integration_group

remove_integration_link

update_integration_link_token


addips

delip

get_public_ip

get_shared_ip

ipv6_disable_account

ipv6_enable_account

ipv6_range_add

ipv6_range_edit

ipv6_range_list

ipv6_range_remove

ipv6_range_usage

listips

nat_checkip

nat_set_public_ip

setsiteip


disable_dkim

disable_mail_sni

emailtrack_search

emailtrack_stats

emailtrack_user_stats

enable_dkim

enable_mail_sni

ensure_dkim_keys_exist

exim_configuration_check

expunge_mailbox_messages

expunge_messages_for_mailbox_guid

fetch_dkim_private_keys

fetch_mail_queue

generate_mobileconfig

get_mailbox_status

get_mailbox_status_list

get_unique_recipient_count_per_sender_for_user

get_unique_sender_recipient_count_per_user

get_user_email_forward_destination

hold_outgoing_email

install_dkim_private_keys

install_spf_records

is_sni_supported

list_pops_for

mail_sni_status

rebuild_mail_sni_config

release_outgoing_email

save_spamd_config

set_user_email_forward_destination

suspend_outgoing_email

unsuspend_outgoing_email

validate_current_installed_exim_config

validate_current_dkims

validate_current_ptrs

validate_current_spfs

validate_exim_configuration_syntax


disable_market_provider

enable_market_provider

get_adjusted_market_providers_products

get_market_providers_commission_config

get_market_providers_list

get_market_providers_product_metadata

get_market_providers_products

set_market_product_attribute

set_market_provider_commission_id


modsec_add_rule

modsec_add_vendor

modsec_assemble_config_text

modsec_batch_settings

modsec_check_rule

modsec_clone_rule

modsec_deploy_all_rule_changes

modsec_deploy_rule_changes

modsec_deploy_settings_changes

modsec_disable_rule

modsec_disable_vendor

modsec_disable_vendor_configs

modsec_disable_vendor_updates

modsec_discard_all_rule_changes

modsec_discard_rule_changes

modsec_edit_rule

modsec_enable_vendor

modsec_enable_vendor_configs

modsec_enable_vendor_updates

modsec_get_config_text

modsec_get_configs

modsec_get_configs_with_changes_pending

modsec_get_log

modsec_get_rules

modsec_get_settings

modsec_get_vendors

modsec_is_installed

modsec_make_config_active

modsec_make_config_inactive

modsec_preview_vendor

modsec_remove_rule

modsec_remove_setting

modsec_remove_vendor

modsec_report_rule

modsec_set_config_text

modsec_set_setting

modsec_undisable_rule

modsec_update_vendor


_getpkgextensionform

add_override_features_for_user

addpkg

addpkgext

changepackage

create_featurelist

delete_featurelist

delpkgext

editpkg

get_available_applications

get_available_featurelists

get_feature_metadata

get_feature_names

get_featurelist_data

get_featurelists

get_users_features_settings

getfeaturelist

getpkginfo

killpkg

listpkgs

manage_features

matchpkgs

read_featurelist

remove_override_features_for_user

update_featurelist

verify_user_has_feature


convert_all_domains_to_fpm

get_fpm_count_and_utilization

is_conversion_in_progress

php_get_default_accounts_to_fpm

php_get_handlers

php_get_impacted_domains

php_get_installed_versions

php_get_old_fpm_flag

php_get_system_default_version

php_get_vhosts_by_version

php_get_vhost_versions

php_ini_get_content

php_ini_get_directives

php_ini_set_content

php_ini_set_directives

php_set_default_accounts_to_fpm

php_set_handler

php_set_old_fpm_flag

php_set_session_save_path

php_set_system_default_version

php_set_vhost_versions


acctcounts

get_public_contact

getresellerips

listacls

listresellers

resellerstats

saveacllist

set_public_contact

setacls

setresellerips

setresellerlimits

setresellermainip

setresellernameservers

setresellerpackagelimit

setupreseller

suspendreseller

terminatereseller

unsetupreseller

unsuspendreseller


delete_rpm_version

edit_rpm_version

get_rpm_version_data

install_rpm_plugin

list_rpms

package_manager_fixcache

package_manager_get_build_log

package_manager_get_package_info

package_manager_is_performing_actions

package_manager_list_packages

package_manager_resolve_actions

package_manager_submit_actions

package_manager_upgrade

uninstall_rpm_plugin


delete_hook

edit_hook

list_hooks

reorder_hooks


accesshash

authorizesshkey

check_remote_ssh_connection

convertopensshtoputty

deletesshkey

fetch_security_advice

generatesshkeypair

importsshkey

listsshkeys


add_configclusterserver

configurebackgroundprocesskiller

configureservice

cors_proxy_get

create_user_session

delete_configclusterserver

enable_monitor_all_enabled_services

get_all_contact_importances

get_appconfig_application_list

get_application_contact_event_importance  

get_application_contact_importance

get_available_profiles

get_current_profile

get_password_strength

get_remote_access_hash

get_service_config

get_service_config_key

get_tcp4_sockets

get_tcp6_sockets

get_tweaksetting

get_udp4_sockets

get_udp6_sockets

get_update_availability

get_users_links

getdiskusage

gethostname

is_role_enabled

list_configclusterservers

loadavg

nvget

nvset

personalization_get

personalization_set

purchase_a_license

reboot

remove_in_progress_exim_config_edit

restartservice

restore_config_from_file

restore_config_from_upload

run_cpkeyclt

send_test_posturl

send_test_pushbullet_note

servicestatus

set_application_contact_event_importance

set_application_contact_importance  

set_primary_servername

set_service_config_key

set_tweaksetting

sethostname

setminimumpasswordstrengths

start_profile_activation

system_needs_reboot

systemloadavg

update_configclusterserver

update_contact_email

verify_aim_access

verify_icq_access

verify_oscar_access

verify_posturl_access

verify_pushbullet_access


disable_autossl

fetch_service_ssl_components

fetch_ssl_certificates_for_fqdns

fetch_ssl_vhosts

fetch_vhost_ssl_components

fetchcrtinfo

fetchsslinfo

generatessl

get_autossl_check_schedule

get_autossl_log

get_autossl_logs_catalog

get_autossl_metadata

get_autossl_pending_queue

get_autossl_pending_queue_for_domain

get_autossl_pending_queue_for_user

get_autossl_problems_for_domain

get_autossl_problems_for_user

get_autossl_providers

get_best_ssldomain_for_service

install_service_ssl_certificate

installssl

listcrts

rebuildinstalledssldb

rebuilduserssldb

reset_autossl_provider

reset_service_ssl_certificate

set_autossl_metadata

set_autossl_metadata_key

set_autossl_provider

start_autossl_check_for_all_users

start_autossl_check_for_one_user


generate_cpanel_plugin

list_styles

load_style

remove_logo

remove_style

save_style

set_default


ticket_create_stub_ticket

ticket_get_support_agreement

ticket_get_support_info

ticket_grant

ticket_list

ticket_remove_closed

ticket_revoke

ticket_ssh_test

ticket_ssh_test_start

ticket_update_service_agreement_approval

ticket_validate_oauth2_code

ticket_whitelist_check

ticket_whitelist_setup

ticket_whitelist_unsetup


abort_transfer_session

analyze_transfer_session_remote

available_transfer_modules

create_remote_root_transfer_session

create_remote_user_transfer_session

delete_account_archives

enqueue_transfer_item

fetch_transfer_session_log

get_transfer_session_state

pause_transfer_session

remote_basic_credential_check

retrieve_transfer_session_remote_analysis

start_transfer_session

transfer_module_schema

validate_system_user


accept_eula

get_available_tiers

get_current_lts_expiration_status

get_lts_wexpire

getlongtermsupport

installed_versions

set_cpanel_updates

set_tier

update_updateconf

version