Hostilla API documentation

Hostilla API: cPanel UAPI and WHM API commands

A bilingual Hostilla.pl index of cPanel UAPI and WHM API commands. Each command has its own page with the API path, CLI example, operational context and a link to the official cPanel documentation.

cPanel UAPI 605 WHM API 1 622 cPanel tools Ask support

cPanel UAPI commands

User-level cPanel automation for mail, files, domains, databases, DNS, SSL and account functions.

Account Enhancements2 commands Backup5 commands Bandwidth3 commands Batch1 commands BlockIP2 commands BoxTrapper25 commands Branding5 commands CacheBuster2 commands CCS5 commands Chkservd2 commands Chrome1 commands ClamScanner6 commands ContactInformation6 commands Contactus1 commands cPanel Server Information1 commands cPGreyList6 commands CSVImport1 commands DAV12 commands DCV3 commands DirectoryIndexes3 commands DirectoryPrivacy6 commands DirectoryProtection1 commands DNS10 commands DNSSEC12 commands Domain3 commands DomainInfo5 commands DynamicDNS5 commands EA41 commands Email92 commands Email DNS Settings4 commands EmailAuth12 commands ExternalAuthentication5 commands Features5 commands File Restoration8 commands Fileman8 commands Ftp20 commands GPG7 commands ImageManager4 commands InProductSurvey1 commands Integration1 commands KnownHosts4 commands LangPHP11 commands LastLogin1 commands Locale3 commands LogManager4 commands Mailboxes5 commands Market19 commands Mime14 commands ModSecurity6 commands Mysql25 commands NginxCaching4 commands Notifications1 commands Parser1 commands PassengerApps7 commands PasswdStrength1 commands Personalization2 commands PHP1 commands Plugins2 commands Postgresql14 commands Pushbullet1 commands Quota2 commands Resellers1 commands ResourceUsage1 commands ServerInformation1 commands ServiceProxy3 commands Session4 commands Sitejet13 commands SiteQuality13 commands SpamAssassin4 commands SSH2 commands SSL50 commands Stats5 commands StatsBar1 commands StatsManager2 commands SubDomain1 commands Subdomains1 commands Team Roles1 commands Team Users17 commands Themes3 commands Tokens4 commands TwoFactorAuth5 commands UserData2 commands UserManager11 commands Users1 commands UserTasks2 commands Variables2 commands VersionControl4 commands VersionControlDeployment3 commands WebDisk4 commands WebmailApps1 commands WebVhosts2 commands WordPressBackup6 commands WordPressRestore3 commands WordPressSite2 commands

Account Enhancements2

has_enhancementValidate Account Enhancement assignment listReturn all cPanel account's Account Enhancements

Backup5

fullbackup_to_ftpBack up cPanel account via FTP fullbackup_to_homedirBack up cPanel account to home directory fullbackup_to_scp_with_keyBack up cPanel account via SCP with SSH key fullbackup_to_scp_with_passwordBack up cPanel account via SCP with password list_backupsReturn backup files

Bandwidth3

get_enabled_protocolsReturn services monitored in bandwidth data get_retention_periodsReturn bandwidth retention period queryReturn cPanel account's bandwidth usage report

Batch1

strictRun multiple UAPI functions in order

BlockIP2

add_ipAdd IP address to cPanel account's block list remove_ipRemove IP address from cPanel account's block list

BoxTrapper25

blacklist_messagesAdd email address to BoxTrapper blocked senders delete_messagesDelete messages in the BoxTrapper queue deliver_messagesSend messages in the BoxTrapper queue get_allowlistReturn account BoxTrapper allowlist rules get_blocklistReturn account BoxTrapper blocklist rules get_configurationReturn email account's BoxTrapper configuration get_email_templateReturn specified BoxTrapper email template get_forwardersReturn all BoxTrapper forwarders get_ignorelistReturn account BoxTrapper ignorelist rules get_logReturn BoxTrapper log file and contents get_messageReturn message's top 200 lines in BoxTrapper queue get_statusReturn whether email account uses BoxTrapper ignore_messagesAdd email account to Exim ignore list list_email_templatesReturn BoxTrapper email templates list_queued_messagesReturn email account's BoxTrapper queued messages process_messagesRun a specific BoxTrapper action for a message reset_email_templateRestore default BoxTrapper email message template save_configurationUpdate email account's BoxTrapper configuration save_email_templateSave BoxTrapper message template contents set_allowlistUpdate account BoxTrapper allowlist set_blocklistUpdate account BoxTrapper blocklist set_forwardersAdd email address to BoxTrapper forwarders set_ignorelistUpdate account BoxTrapper ignorelist set_statusEnable or disable BoxTrapper for email account whitelist_messagesAdd email address to BoxTrapper allowed senders

Branding5

get_application_informationReturn single app's info from dynamicui.conf get_applicationsReturn multiple apps' info from dynamicui.conf get_available_applicationsReturn current user's cPanel application details get_information_for_applicationsReturn app's info from sitemap.json includeReturn branding file content from the active theme

CacheBuster2

readReturn web browser cached file override ID updateCreate web browser cached file override ID

CCS5

add_delegateAdd calendar delegation list_delegatesList cPanel account's calendar delegates list_usersList cPanel account's calendar users remove_delegateRemove calendar delegation update_delegateUpdate calendar delegation

Chkservd2

get_exim_portsReturn outgoing (SMTP) mail port get_exim_ports_sslReturn outgoing mail (SMTP) SSL-secured port

Chrome1

get_domReturn cPanel theme header and footer HTML

ClamScanner6

check_disinfection_statusRequest disinfection process status disinfect_filesStart disinfecting files with viruses get_scan_pathsReturn virus scan types get_scan_statusRequest virus scan status list_infected_filesReturn infected file list start_scanStart virus scan

ContactInformation6

get_notification_preferencesReturn the account's notification preferences.get_pushbullet_access_tokenReturn Pushbullet access token set_email_addressesSet contact email address(es)set_notification_preferencesSet the account's notification preferences.set_pushbullet_access_tokenUpdate Pushbullet access token unset_email_addressesUnset contact email addresses

Contactus1

is_enabledReturn whether contact option is enabled

cPanel Server Information1

get_server_informationReturn server's configuration settings

cPGreyList6

disable_all_domainsDisable Greylisting for all domains disable_domainsDisable Greylisting for specified domains enable_all_domainsEnable Greylisting for all domains enable_domainsEnable Greylisting for specified domains has_greylisting_enabledReturn whether Greylisting is enabled list_domainsReturn Greylisting status for domains

CSVImport1

doimportImport email accounts from CSV file

DAV12

add_delegateShare a calendar disable_shared_global_addressbookDisable global address book enable_shared_global_addressbookEnable global address book get_calendar_contacts_configReturn CalDAV and CardDAV connection information has_shared_global_addressbookReturn whether global address book is enabled is_dav_service_enabledReturn whether DAV is enabled is_horde_enabledReturn whether Horde is enabled list_delegatesList calendar sharing.list_usersUpdate calendar sharing manage_collectionManage a calendar, task list, or address book remove_delegateRemove a share.update_delegateUpdate calendar sharing.

DCV3

check_domains_via_dnsVerify domain ownership via DNS check_domains_via_httpVerify domain ownership via HTTP ensure_domains_can_pass_dcvVerify domain ownership

DirectoryIndexes3

get_indexingReturn directory indexing settings list_directoriesReturn subdirectories directory indexing settings set_indexingUpdate directory indexing settings

DirectoryPrivacy6

add_userAdd authorized user for protected directory configure_directory_protectionEnable or disable protected directory delete_userDelete authorized user for protected directory is_directory_protectedReturn whether directory uses password protection list_directoriesReturn privacy status of subdirectories list_usersReturn authorized users for protected directory

DirectoryProtection1

list_directoriesReturn Directory Protection settings

DNS10

ensure_domains_reside_only_locallyReturn whether domains only resolve locally fetch_cpanel_generated_domainsRetrieve cPanel-generated subdomains for a domain has_local_authorityReturn whether local DNS server is authoritative is_alias_availableReturn `ALIAS` DNS record availability & resolver is_https_availableReturn DNS HTTPS record support information is_svcb_availableReturn DNS SVCB record support information lookupReturn domain's DNS information mass_edit_zoneUpdate a DNS zone parse_zoneReturn a parsed DNS zone swap_ip_in_zonesUpdate IP addresses in zone files

DNSSEC12

activate_zone_keyEnable DNSSEC security key add_zone_keyCreate DNSSEC security key deactivate_zone_keyDisable DNSSEC security key disable_dnssecDisable DNSSEC enable_dnssecEnable DNSSEC export_zone_dnskeyExport DNSKEY record value export_zone_keyExport DNSSEC security key fetch_ds_recordsReturn domain's DS records import_zone_keyAdd DNSSEC security key remove_zone_keyRemove DNSSEC security key set_nsec3Update domain to use NSEC3 unset_nsec3Update domain to use NSEC

Domain3

convert_temporary_to_registeredConvert a temporary domain to a registered domain is_temporary_domainReturn whether a domain is temporary temporary_domain_is_disabledReturn whether temporary domains are disabled

DomainInfo5

domains_dataReturn all domains' hosting configuration list_domainsReturn cPanel account's domains main_domain_builtin_subdomain_aliasesReturn built-in subdomain aliases primary_domainReturn the cPanel account's primary domain single_domain_dataReturn domain's hosting configuration

DynamicDNS5

createCreate Dynamic DNS domain deleteDelete Dynamic DNS domain listReturn Dynamic DNS domains recreateUpdate Dynamic DNS domain ID set_descriptionUpdate Dynamic DNS domain description

EA41

get_recommendationsGet EA4 configuration recommendations

Email92

Email DNS Settings4

add_mxCreate mail exchanger record change_mxUpdate mail exchanger record delete_mxDelete mail exchanger record list_mxsReturn mail exchanger records

EmailAuth12

apply_dmarcApply DMARC records to domains.disable_dkimRemove domains' DKIM records enable_dkimEnable domains' DKIM records ensure_dkim_keys_existValidate domains' DKIM private keys fetch_dkim_private_keysReturn domains' DKIM private keys install_dkim_private_keysAdd domains' DKIM record keys install_spf_recordsAdd domains' SPF records remove_dmarcRemove DMARC record from domain(s)validate_current_dkimsValidate domains' DKIM records validate_current_dmarcsValidate domains' DMARC records validate_current_ptrsValidate domains' PTR records validate_current_spfsValidate domains' SPF records

ExternalAuthentication5

add_authn_linkAdd external authentication link configured_modulesReturn server's external authentication providers get_authn_linksReturn external authentication links has_external_auth_modules_configuredReturn external authentication user status remove_authn_linkRemove external authentication link

Features5

get_feature_metadataReturn cPanel account's features' metadata has_featureValidate cPanel account's feature access has_features_likeReturn whether queried features are enabled list_featuresReturn cPanel account's features list_features_likeReturn queried cPanel account features

File Restoration8

directory_listingReturn backups in home directory get_usersReturn cPanel accounts with backup metadata query_file_infoReturn backup storage locations restore_databasesRestore databases restore_email_filtersRestore email filters restore_email_forwardersRestore email forwarders restore_fileRestore file or directory restore_filesRestore files

Fileman8

autocompletedirReturn autocomplete file and directory names empty_trashDelete .trash folder content get_file_contentReturn file content get_file_informationReturn file or directory information list_filesReturn directory content save_file_contentSave file transcodeUpdate buffer encoding upload_filesUpload files

Ftp20

add_ftpCreate FTP account allows_anonymous_ftpReturn if anonymous FTP connections allowed allows_anonymous_ftp_incomingReturn if anonymous FTP transfers allowed delete_ftpDelete FTP account ftp_existsReturn whether an FTP account exists get_ftp_daemon_infoReturn FTP server's information get_portReturn FTP server's port get_quotaReturn FTP account's quota get_welcome_messageReturn FTP account's welcome message kill_sessionStop FTP session list_ftpReturn FTP accounts list_ftp_with_diskReturn FTP accounts and disk usage list_sessionsReturn FTP server's active sessions passwdUpdate FTP account's password server_nameReturn whether server uses ProFTPD or Pure-FTPd set_anonymous_ftpEnable or disable anonymous FTP logins set_anonymous_ftp_incomingEnable or disable anonymous incoming FTP transfers set_homedirUpdate FTP account's home directory set_quotaUpdate FTP account's quota set_welcome_messageUpdate FTP welcome message

GPG7

delete_keypairDelete GnuPG key pair export_public_keyExport GnuPG public key export_secret_keyExport GnuPG secret key generate_keyCreate GnuPG key import_keyImport GnuPG key list_public_keysReturn current user's GnuPG public keys list_secret_keysReturn current user's GnuPG secret keys

ImageManager4

convert_fileCreate image with new format create_thumbnailsCreate image thumbnails get_dimensionsReturn image dimensions resize_imageSave resized image

InProductSurvey1

get_in_product_survey_urlReturn in-product survey banner data

Integration1

fetch_urlReturn integrated application URL

KnownHosts4

createCreate host deleteDelete host updateUpdate host in the known_hosts file verifyValidate host

LangPHP11

php_get_domain_handlerReturn PHP version's handler php_get_impacted_domainsReturn domains that shared PHP configuration php_get_installed_versionsReturn installed PHP versions php_get_system_default_versionReturn default PHP version php_get_vhost_versionsReturn virtual host's PHP version php_ini_get_user_basic_directivesReturn basic PHP directives php_ini_get_user_contentReturn virtual host's php.ini content php_ini_get_user_pathsReturn php.ini file paths php_ini_set_user_basic_directivesUpdate basic PHP directives php_ini_set_user_contentUpdate virtual host's php.ini content php_set_vhost_versionsUpdate virtual host's PHP version

LastLogin1

get_last_or_current_logged_in_ipReturn last authenticated login IP address

Locale3

get_attributesReturn current locale settings list_localesReturn available locales set_localeUpdate cPanel account locale

LogManager4

delete_archiveDelete a log archive file get_settingsRetrieve cPanel account's log archival settings list_archivesReturn cPanel account's archive files list set_settingsSave cPanel account's log archive settings

Mailboxes5

expunge_mailbox_messagesDelete selected messages in mailbox expunge_messages_for_mailbox_guidDelete selected messages in mailbox by GUID get_mailbox_status_listReturn cPanel account's mailbox status has_utf8_mailbox_namesReturn if cPanel account's mailboxes use UTF-8 set_utf8_mailbox_namesEnable or disable Webmail mailbox UTF-8 encoding

Market19

cancel_pending_ssl_certificateDelete an order create_shopping_cartCreate shopping cart create_shopping_cart_non_sslCreate shopping cart for non-SSL products get_all_productsReturn provider's available products get_build_cart_urlBuild cart URL for a product get_certificate_status_detailsReturn provider's SSL certificate request status get_completion_urlGet product purchase completion URL get_license_infoRetrieve license information for a domain get_login_urlReturn provider's login URL get_pending_ssl_certificatesReturn provider's pending SSL certificates get_product_infoRetrieve product information get_provider_specific_dcv_constraintsReturn provider's DCV filename requirements get_providers_listReturn enabled providers get_ssl_certificate_if_availableReturn provider's available SSL certificates process_ssl_pending_queueStart processing pending queue's SSL certificates request_ssl_certificatesRequest SSL certificate order set_status_of_pending_queue_itemsUpdate status of items in pending queue set_url_after_checkoutUpdate URL after checkout validate_login_tokenValidate login token

Mime14

add_handlerAdd web server MIME type handler add_hotlinkEnable hotlink protection add_mimeAdd MIME type to web server add_redirectAdd redirect to domain delete_handlerRemove web server MIME type handler delete_hotlinkDisable hotlink protection delete_mimeRemove MIME type from web server delete_redirectRemove redirect from domain get_redirectReturn redirect URL for domain list_handlersReturn web server's MIME handlers list_hotlinksReturn domains with hotlink protection list_mimeReturn web server's MIME types list_redirectsReturn .htaccess files' redirects redirect_infoReturn redirect information

ModSecurity6

disable_all_domainsDisable ModSecurity for all domains disable_domainsDisable ModSecurity for selected domains enable_all_domainsEnable ModSecurity for all domains enable_domainsEnable ModSecurity for selected domains has_modsecurity_installedReturn ModSecurity installation status list_domainsReturn ModSecurity domains' status

Mysql25

add_hostEnable remote MySQL host access add_host_noteAdd remote MySQL host note check_databaseValidate MySQL database integrity create_databaseCreate MySQL database create_userCreate MySQL user delete_databaseDelete MySQL database delete_hostDisable remote MySQL host access delete_userDelete MySQL user dump_database_schemaReturn MySQL database schema get_host_notesReturn remote MySQL host notes get_privileges_on_databaseReturn MySQL user privileges get_restrictionsReturn MySQL name length restrictions get_server_informationReturn MySQL server host information and version list_databasesReturn MySQL databases list_routinesReturn MySQL user routines list_usersReturn MySQL users locate_serverReturn MySQL server host information rename_databaseUpdate MySQL database name rename_userUpdate MySQL username repair_databaseRepair MySQL database tables revoke_access_to_databaseRemove MySQL user privileges set_passwordUpdate MySQL user password set_privileges_on_databaseUpdate MySQL user privileges setup_db_and_userCreate a randomly named MySQL username/database set.update_privilegesUpdate MySQL® privileges

NginxCaching4

clear_cacheDelete NGINX cache contents.disable_cacheDisable the user's NGINX cache enable_cacheEnable the user's NGINX cache reset_cache_configReset the user's NGINX cache configuration

Notifications1

get_notifications_countReturn server notifications total

Parser1

firstfile_relative_uriReturn session relative URI

PassengerApps7

disable_applicationDisable Passenger application edit_applicationUpdate Passenger application settings enable_applicationEnable Passenger application ensure_depsInstall Passenger application dependencies list_applicationsReturn Passenger applications register_applicationRegister Passenger application unregister_applicationUnregister Passenger application

PasswdStrength1

get_required_strengthReturn minimum required password strength

Personalization2

getRetrieve NVData data from file setSave NVData data to file

PHP1

get_php_recommendationsGet custom PHP recommendations.

Plugins2

can_show_promotionsEnable plugin promotions create_userCreate third-party user

Postgresql14

create_databaseCreate PostgreSQL database create_userCreate PostgreSQL user delete_databaseDelete PostgreSQL database delete_userDelete PostgreSQL user get_restrictionsReturn PostgreSQL name length restrictions grant_all_privilegesEnable all user privileges on PostgreSQL database list_databasesReturn PostgreSQL databases list_usersReturn PostgreSQL users rename_databaseUpdate PostgreSQL database name rename_userUpdate PostgreSQL username rename_user_no_passwordUpdate PostgreSQL username without password revoke_all_privilegesRemove PostgreSQL user privileges set_passwordUpdate PostgreSQL user password update_privilegesUpdate PostgreSQL® privileges

Pushbullet1

send_test_messageValidate Pushbullet token

Quota2

get_local_quota_infoReturn local disk quota information get_quota_infoReturn disk quota information

Resellers1

list_accountsReturn reseller's cPanel accounts

ResourceUsage1

get_usagesReturn resource usage and custom statistics

ServerInformation1

get_informationReturn service and device status

ServiceProxy3

get_service_proxy_backendsReturn a cPanel account’s service proxying setup set_service_proxy_backendsAdd cPanel account service proxying unset_all_service_proxy_backendsRemove cPanel account service proxying

Session4

create_temp_userCreate user session with existing session create_webmail_session_for_mail_userCreate Webmail session create_webmail_session_for_mail_user_check_passwordCreate Webmail session with credentials create_webmail_session_for_selfCreate Webmail session for current user

Sitejet13

add_api_tokenAdd an existing Sitejet API token.can_create_domainsReturn Domain Availability create_accountGenerate a Sitejet API key.create_restore_pointCreate a restore point.create_websiteCreate Sitejet domain ID get_all_user_sitejet_infoReturn Sitejet domains get_api_tokenReturn Sitejet API token get_preview_urlReturn Sitejet preview URL get_sso_linkReturn Sitejet SSO URL get_templatesReturn Sitejet templates restore_document_rootRestore a domain from the restore point.set_templateUpdate Sitejet template start_publishPublish Sitejet domain

SiteQuality13

create_projectAdd domain to monitoring create_site_quality_userRegister cPanel user for monitoring delete_site_quality_userDelete Site Quality Monitoring account get_all_scoresReturn all projects' monitoring results get_app_tokenReturn koality authentication token get_monitored_domainsReturn the user's monitored domains.get_monitored_system_scoresReturn status for a user's monitored domains.has_site_quality_userValidate monitoring account existence is_site_quality_user_enabledValidate monitoring account enablement reset_configRemove monitoring user from cPanel configuration send_activation_emailRequest activation email update_domainUpdate domain name in Site Quality Monitoring project verify_codeValidate activation code

SpamAssassin4

clear_spam_boxDelete spam box contents get_symbolic_test_namesReturn SpamAssassin™ symbolic test scores get_user_preferencesReturn SpamAssassin™ settings update_user_preferenceUpdate SpamAssassin™ settings

SSH2

get_portReturn SSH port get_shellReturn whether cPanel account has shell access

SSL50

add_autossl_excluded_domainsDisable AutoSSL for domains can_ssl_redirectReturn whether domains can redirect to secure URL check_shared_certReturn whether shared SSL certificate exists delete_certDelete SSL certificate delete_csrDelete certificate signing request delete_keyDelete private key delete_sslRemove SSL for domain disable_mail_sniDisable SNI mail services for domain enable_mail_sniEnable SNI mail services for domain fetch_best_for_domainRequest best SSL certificate fetch_cert_infoReturn SSL certificate information fetch_certificates_for_fqdnsReturn SSL certificate information for all FQDN fetch_key_and_cabundle_for_certificateReturn private key and CA bundle find_certificates_for_keyReturn SSL certificate for private key find_csrs_for_keyReturn private key's certificate signing requests generate_certCreate self-signed SSL certificate generate_csrCreate certificate signing request generate_keyCreate private key get_autossl_excluded_domainsReturn AutoSSL disabled domains get_autossl_problemsReturn domains with AutoSSL problems get_autossl_renewal_statusReturn AutoSSL renewal status for a domain get_cabundleReturn certificate's CA bundle and hostname get_cn_nameRequest best SSL domain for service install_sslInstall SSL certificate installed_hostReturn SSL certificate's info for dedicated IP installed_hostsReturn domains with SSL certificate information is_autossl_check_in_progressReturn whether AutoSSL check in progress is_mail_sni_supportedReturn whether mail SNI is enabled is_sni_supportedReturn whether Apache web server supports mail SNI list_certsReturn all SSL certificates list_csrsReturn all certificate signing requests list_keysReturn all private keys list_ssl_itemsReturn SSL-related items mail_sni_statusReturn status of domain's SNI mail services rebuild_mail_sni_configStart SNI configuration files rebuild rebuildssldbStart SSL database rebuild remove_autossl_excluded_domainsEnable AutoSSL for specifed domains set_autossl_excluded_domainsDisable AutoSSL for specifed domains set_cert_friendly_nameUpdate SSL certificate's friendly name set_csr_friendly_nameUpdate certificate signing request's friendly name set_default_key_typeUpdate SSL TLS key type set_key_friendly_nameUpdate private key's friendly name set_primary_sslUpdate SSL website for dedicated IP address show_certExport SSL certificate show_csrExport certificate signing request show_keyExport private key start_autossl_checkStart AutoSSL for current user toggle_ssl_redirect_for_domainsEnable or disable secure redirects upload_certImport SSL certificate upload_keyImport private key

Stats5

get_bandwidthReturn bandwidth statistics for all domains get_site_errorsReturn specified domain access log get_stats_dailyReturn daily AwStats statistics for a domain list_sitesReturn Analog statistics for all domains list_stats_by_domainReturn Analog statistics for specified domain

StatsBar1

get_statsReturn cPanel account statistics

StatsManager2

get_configurationReturns weblog analyzers' configuration save_configurationSave current user's weblog analyzers configuration

SubDomain1

addsubdomainCreate subdomain

Subdomains1

changedocrootChange a subdomain or addon domain document root

Team Roles1

list_feature_descriptionsList all role feature descriptions

Team Users17

add_rolesAdd roles to a team user add_team_userAdd a team user cancel_expireStop a team user from expiring edit_team_userEdit a team user get_team_users_with_roles_countGet number of team users with roles list_teamList Team Users password_reset_requestSends a password reset request link to team user.reinstate_team_userReinstate a team user remove_rolesRemove roles from a team user remove_team_userRemove a team user set_contact_emailSet a contact email address for a team user set_expireSet a team user to expire set_localeSet locale for a team user set_notesSet notes for a team user set_passwordSet password for a team user set_rolesSet roles for a team user suspend_team_userSuspend a team user

Themes3

get_theme_baseReturn current theme listReturn available themes updateUpdate current theme

Tokens4

create_full_accessCreate cPanel API token listReturn cPanel API tokens renameUpdate cPanel API token's name revokeRemove cPanel API token

TwoFactorAuth5

generate_user_configurationCreate 2FA authentication code get_team_user_configurationReturn team user 2FA config get_user_configurationReturn cPanel account 2FA config remove_user_configurationRemove 2FA config set_user_configurationSave 2FA config

UserData2

get_scoped_userdataReturn scoped userdata mapping set_scoped_userdataSet scoped userdata key/value

UserManager11

change_passwordUpdate cPanel account password check_account_conflictsReturn Subaccounts and service accounts conflicts create_userCreate Subaccount delete_userDelete Subaccount dismiss_mergeRemove service account link request edit_userUpdate Subaccount settings list_usersReturn cPanel account's Subaccounts lookup_service_accountReturn service account's information lookup_userReturn Subaccount's information merge_service_accountRegister service account to Subaccount unlink_service_accountUnregister service account from Subaccount

Users1

change_passwordUpdate cPanel account password

UserTasks2

deleteRemove item from task queue retrieveReturn task queue information

Variables2

get_session_informationReturn web server's hostname get_user_informationReturn cPanel account's configuration settings

VersionControl4

createCreate Git repository deleteDelete Git repository retrieveReturn Git repositories updateUpdate Git repository settings

VersionControlDeployment3

createCreate Git deployment task deleteDelete Git deployment task retrieveReturn Git deployment task status

WebDisk4

delete_userDelete Web Disk account set_homedirUpdate Web Disk home directory location set_passwordUpdate Web Disk account password set_permissionsUpdate Web Disk home directory permissions

WebmailApps1

list_webmail_appsReturn available webmail clients

WebVhosts2

list_domainsReturn virtual host names for domains list_ssl_capable_domainsReturn domains that allow SSL certificate purchase

WordPressBackup6

any_runningReturn all WordPress sites' backup status cancelStop WordPress site backup cleanupDelete WordPress backup temporary files get_available_backupsReturn WordPress site backups is_runningReturn WordPress site backup status startBackup WordPress site

WordPressRestore3

any_runningReturn WordPress site restore status cleanupDelete restored WordPress site's temporary files startRestore WordPress site

WordPressSite2

createInstall WordPress site retrieveReturn WordPress site information

WHM API 1

Server, reseller and administrative automation for WHM environments.

360 Monitoring2 commands Account Creation4 commands Account Enhancements6 commands Account Management4 commands Account Restoration16 commands Accounts10 commands API Execution5 commands Applications1 commands Authentication30 commands Backups27 commands Bandwidth and Disk Quotas5 commands Configurations2 commands cPanel Analytics1 commands cPHulk17 commands Customizations3 commands Databases27 commands DNS44 commands Domain Information9 commands EasyApache7 commands Greylisting15 commands InProductSurvey1 commands Integration8 commands IP Addresses16 commands Mail51 commands Market9 commands ModSecurity38 commands NGINX Manager6 commands Packages26 commands Passwords3 commands PHP14 commands PHP-FPM9 commands Plugin-Based Features3 commands Resellers21 commands RPM14 commands Script Hooks4 commands Security3 commands Server Administration64 commands Services3 commands Sitejet4 commands SSH Keys and Connections8 commands SSL34 commands Styles1 commands Support Tickets14 commands Suspensions4 commands Transfers15 commands Updates9 commands UserData2 commands Web Log Retention1 commands WHM Access2 commands

360 Monitoring2

register_server_with_360_monitoringRegister the server with 360 Monitoring set_360_agent_pollingUpdate 360 Monitoring agent polling settings

Account Creation4

createacctCreate cPanel account get_current_users_countReturn cPanel accounts total number get_maximum_usersReturn maximum accounts for license verify_new_usernameValidate new cPanel account username

Account Enhancements6

assign_account_enhancementAssign Account Enhancement create_account_enhancementCreate Account Enhancement delete_account_enhancementRemove an Account Enhancement list_account_enhancementsReturn Account Enhancements modify_account_enhancementUpdate Account Enhancement unassign_account_enhancementUnassign Account Enhancement

Account Management4

get_homedir_rootsReturn home directories list list_usersReturn root and cPanel accounts removeacctDelete cPanel account set_primary_domain_docrootChange document root for cPanel account primary domain

Account Restoration16

restore_modules_summaryReturn backup modules list restore_queue_activateStart restoration restore_queue_add_taskRestore user account from backup restore_queue_clear_all_completed_tasksRemove all completed restoration tasks restore_queue_clear_all_failed_tasksRemove all failed restoration tasks restore_queue_clear_all_pending_tasksRemove all pending restoration tasks restore_queue_clear_all_tasksRemove all restoration tasks restore_queue_clear_completed_taskRemove completed restoration task restore_queue_clear_pending_taskRemove pending restoration task restore_queue_is_activeValidate restoration queue is active restore_queue_list_activeReturn active restoration tasks list restore_queue_list_completedReturn completed restoration tasks list restore_queue_list_pendingReturn pending restoration tasks list restore_queue_stateReturn restoration tasks list restoreaccountRestore account backup verify_new_username_for_restoreValidate username during restoration

Accounts10

accountsummaryReturn cPanel account summary get_upgrade_opportunitiesGet upgrade opportunities has_digest_authValidate cPanel account Digest Authentication has_mycnf_for_cpuserValidate MySQL Configuration file listacctsReturn cPanel accounts massmodifyacctUpdate multiple cPanel accounts modifyacctUpdate cPanel account myprivsReturn cPanel account system privileges set_digest_authEnable or disable Digest Authentication untrack_acct_idRemove UID or GID from tracked list

API Execution5

batchRun multiple WHM API 1 functions cors_proxy_getEnable CORS HTTP requests cpanelRun cPanel API or UAPI function execute_remote_whmapi1_with_passwordRun remote WHM API 1 function uapi_cpanelRun UAPI function through WHM API

Applications1

applistReturn WHM API 1 functions list

Authentication30

api_token_createCreate WHM API token api_token_get_detailsLook up API token details api_token_listReturn WHM API tokens api_token_revokeDisable WHM API token api_token_updateUpdate WHM API token's settings disable_authentication_providerDisable identity provider disable_failing_authentication_providersDisable identity provider modules that fail to load enable_authentication_providerEnable identity provider get_available_authentication_providersReturn available identity providers get_login_urlReturn cPanel Store or cPanel Market login URL get_provider_client_configurationsReturn identity provider client configuration get_provider_configuration_fieldsReturn identity provider configuration fields get_provider_display_configurationsReturn identity provider login interface appearance get_users_authn_linked_accountsReturn accounts linked to identity providers link_user_authn_providerAdd identity provider to cPanel account set_provider_client_configurationsUpdate identity provider client configuration set_provider_display_configurationsUpdate identity provider login interface appearance twofactorauth_disable_policyDisable 2FA twofactorauth_enable_policyEnable 2FA twofactorauth_generate_tfa_configCreate a one-time authentication secret and code twofactorauth_get_issuerReturn configured issuer for current user twofactorauth_get_tfa_config_for_userReturn cPanel account 2FA data twofactorauth_get_user_configsReturn cPanel accounts with 2FA enabled twofactorauth_policy_statusReturn 2FA policy status twofactorauth_remove_user_configRemove 2FA settings twofactorauth_set_issuerUpdate 2FA issuer value twofactorauth_set_tfa_configUpdate 2FA authentication secret and code twofactorauth_set_tfa_config_for_userUpdate cPanel account's 2FA data unlink_user_authn_providerUnregister cPanel account from authentication provider validate_login_tokenValidate login token and return access token

Backups27

backup_config_getReturn backup configuration file data backup_config_setUpdate the system's backup configuration backup_date_listReturn dates where backup files exist backup_destination_addAdd a backup destination backup_destination_deleteDelete a backup destination backup_destination_getReturn a backup destination's settings backup_destination_listReturn a list of backup destinations backup_destination_setUpdate backup destination settings backup_destination_validateValidate a backup destination backup_does_client_id_have_google_credentialsReturn Google Drive™ client ID credentials backup_generate_google_oauth_uriCreate Google Drive™ OAuth redirect URI backup_get_transport_statusReturn backup transport events' status backup_list_transportedReturn backup files sent through transport backup_set_listReturn backup files in the local disk backup_set_list_combinedReturn backup files for the server's accounts backup_skip_users_allEnable or disable backups backup_skip_users_all_statusReturn backup configuration status backup_user_listReturn users with a backup file convert_and_migrate_from_legacy_configMigrate server to new backup system fetch_pkgacct_master_logReturn start_background_pkgacct session log file get_pkgacct_session_stateReturn start_background_pkgacct session state get_users_and_domains_with_backup_metadataReturn users and domains with backup metadata get_users_with_backup_metadataReturn users with backup metadata list_cparchive_filesReturn cparchive files list start_background_pkgacctBack up an account using the pkgacct script start_local_cpmove_restoreRestore one cPanel account from a backup toggle_user_backup_stateEnable or disable legacy backups

Bandwidth and Disk Quotas5

editquotaUpdate cPanel account disk quota get_disk_usageReturn all cPanel accounts disk usage limitbwUpdate cPanel account bandwidth quota quota_enabledValidate cPanel account quotas showbwReturn cPanel account bandwidth information

Configurations2

get_tweaksettingReturn Tweak Settings option's value set_tweaksettingUpdate Tweak Settings option

cPanel Analytics1

participate_in_analyticsEnable analytics data gathering

cPHulk17

Customizations3

delete_customizationsDelete customization data retrieve_customizationsRetrieve customization data update_customizationsUpdate customization data

Databases27

background_mysql_upgrade_checker_runValidate MySQL status before upgrade background_mysql_upgrade_statusReturn MySQL or MariaDB upgrade status current_mysql_versionReturn MySQL version get_database_optimizationsReturn MySQL database optimizations installable_mysql_versionsReturn available MySQL versions latest_available_mysql_versionReturn latest MySQL version list_database_usersReturn MySQL users list_databasesReturn MySQL databases list_mysql_databases_and_usersReturn MySQL databases and users for account remote_mysql_create_profileCreate remote MySQL profile remote_mysql_create_profile_via_sshCreate remote MySQL profile via SSH remote_mysql_delete_profileDelete remote MySQL profile remote_mysql_initiate_profile_activationStart remote MySQL profile activation remote_mysql_monitor_profile_activationReturn remote MySQL profile activation remote_mysql_read_profileReturn remote MySQL profile remote_mysql_read_profilesReturn remote MySQL profiles remote_mysql_update_profileUpdate remote MySQL profile remote_mysql_validate_profileValidate remote MySQL profile connection rename_mysql_databaseUpdate MySQL database name rename_mysql_userUpdate MySQL username rename_postgresql_databaseUpdate PostgreSQL database name rename_postgresql_userUpdate PostgreSQL username set_local_mysql_root_passwordUpdate MySQL root password set_mysql_passwordUpdate MySQL user password set_postgresql_passwordUpdate PostgreSQL user password start_background_mysql_upgradeStart background MySQL upgrade update_sql_configUpdate the servers SQL configuration.

DNS44

activate_zone_keyEnable domain's DNSSEC key add_zone_keyCreate domain's DNSSEC zone key adddnsCreate DNS zone addzonerecordCreate DNS zone record cluster_member_has_trust_withReturn whether DNS cluster server can share records create_parked_domain_for_userCreate domain alias create_subdomainCreate subdomain deactivate_zone_keyDisable domain's DNSSEC key delete_domainDelete domain disable_dnssec_for_domainsDisable DNSSEC on domain dumpzoneReturn domain's DNS zone configuration editzonerecordUpdate DNS zone record enable_dnssec_for_domainsEnable DNSSEC on domain export_zone_dnskeyExport domain's DNSKEY record value export_zone_filesExport DNS zones in zone file format export_zone_keyExport domain's DNSSEC key fetch_ds_records_for_domainsReturn domain's DS record get_nameserver_configReturn current user's nameservers getzonerecordReturn specific line from domain's DNS configuration has_local_authorityValidate local server is authoritative import_zone_keyImport DNSSEC key is_alias_availableReturn `ALIAS` DNS record availability & resolver is_https_availableReturn HTTPS DNS record support information is_svcb_availableReturn SVCB DNS record support information killdnsDelete DNS zone listmxsReturn domain's mail exchanger records listzonesReturn server's DNS zones lookupnsipReturn nameserver's IP address lookupnsipsReturn nameserver's IPv4 and IPv6 addresses mass_edit_dns_zoneUpdate a DNS zone parse_dns_zoneReturn a parsed DNS zone remove_zone_keyRemove DNSSEC key removezonerecordDelete DNS zone record resetzoneRestore DNS zone to default values resolvedomainnameReturn domain's IP address savemxsCreate mail exchanger record set_nameserverUpdate remote DNS server's nameserver software set_nsec3_for_domainsEnable NSEC3 semantics for domain set_up_dns_resolver_workaroundsCreate unbound DNS resolver setresolversUpdate server's resolver nameservers unset_nsec3_for_domainsEnable NSEC semantics for domain update_nameservers_configUpdate default nameservers update_reverse_dns_cacheUpdate reverse DNS cache updateuserdomainsUpdate /etc/userdomains file

Domain Information9

convert_addon_fetch_conversion_detailsReturn additional domain conversion details convert_addon_fetch_domain_detailsReturn additional domain data convert_addon_get_conversion_statusReturn conversion status for additional domain convert_addon_initiate_conversionStart additional domain conversion convert_addon_list_addon_domainsReturn current user's additional domains convert_addon_list_conversionsReturn additional domains conversion queue domainuserdataReturn domain user information get_domain_infoReturn all domains information getdomainownerReturn domain owner

EasyApache7

ea4_get_additional_pkg_prefixesReturn any additional package prefixes, beyond `ea`.ea4_get_currently_installed_packagesReturn installed Easyapache 4 packages ea4_list_profilesReturn EasyApache 4 profiles ea4_metainfoReturn ea4-metainfo.json file contents ea4_recommendationsReturn EasyApache 4 recommendations ea4_save_profileCreate EasyApache 4 profile eol_php_sitesCount domains using EOL PHP versions

Greylisting15

cpgreylist_is_server_netblock_trustedReturn Greylisting trust status of server netblock cpgreylist_list_entries_for_common_mail_providerReturn Greylisting IP addresses of mail providers cpgreylist_load_common_mail_providers_configReturn Greylisting mail providers cpgreylist_save_common_mail_providers_configUpdate Greylisting new mail provider handling cpgreylist_statusReturn Greylisting status cpgreylist_trust_entries_for_common_mail_providerAdd mail provider to Greylisting trusted hosts cpgreylist_untrust_entries_for_common_mail_providerAdd mail provider to Greylisting non-trusted hosts create_cpgreylist_trusted_hostAdd IP address to Greylisting trusted hosts delete_cpgreylist_trusted_hostRemove IP address from Greylisting trusted hosts disable_cpgreylistDisable Greylisting enable_cpgreylistEnable Greylisting load_cpgreylist_configReturn Greylisting settings read_cpgreylist_deferred_entriesReturn Greylisting deferred incoming email triplets read_cpgreylist_trusted_hostsReturn Greylisting trusted hosts save_cpgreylist_configUpdate Greylisting settings

InProductSurvey1

get_in_product_survey_urlGet in-product survey URL

Integration8

create_integration_groupCreate integration link group create_integration_linkCreate integration link get_integration_link_user_configReturn integration link configuration list_integration_groupsReturn integration link groups list_integration_linksReturn integration links remove_integration_groupRemove integration link group remove_integration_linkRemove integration link update_integration_link_tokenUpdate integration link token

IP Addresses16

addipsAdd IP addresses delipRemove IP address get_public_ipReturn public IP address of private IP address get_shared_ipReturn shared IP address ipv6_disable_accountRemove IPv6 address range from account ipv6_enable_accountAdd IPv6 address range to accounts ipv6_range_addAdd IPv6 address range ipv6_range_editUpdate IPv6 address range name or note ipv6_range_listReturn available IPv6 address ranges ipv6_range_removeRemove IPv6 address range ipv6_range_usageReturn IPv6 address usage listipsReturn server's IP addresses listipv6sReturn server's IPv6 addresses nat_checkipValidate public IP address for NAT nat_set_public_ipRegister NAT IP address to public IP address setsiteipUpdate domain or cPanel account IP address

Mail51

apply_dmarcApply a DMARC record to a domain block_incoming_email_from_countryAdd block on emails from specific countries block_incoming_email_from_domainAdd block on emails from specific domains disable_dkimDisable domain's DKIM records disable_mail_sni(Deprecated) Disable SNI mail services for domains emailtrack_searchReturn email delivery records by search criteria emailtrack_statsReturn cPanel account email tracking statistics emailtrack_user_statsReturn all cPanel accounts email tracking statistics enable_dkimEnable domain's DKIM records enable_mail_sniEnable SNI mail services for domains ensure_dkim_keys_existValidate domain's DKIM keys exim_configuration_checkRepair Exim configuration file expunge_mailbox_messagesRemove email account messages by Dovecot query expunge_messages_for_mailbox_guidRemove email account messages by mailbox GUID fetch_dkim_private_keysReturn domain's DKIM private key fetch_mail_queueReturn server mail queue contents generate_mobileconfigCreate email account mobile profile configuration get_default_dmarc_recordGet the server's default DMARC record get_mailbox_statusReturn cPanel account mailboxes status by name get_mailbox_status_listReturn cPanel account mailboxes status list get_unique_recipient_count_per_sender_for_userReturn cPanel account unique email recipients get_unique_sender_recipient_count_per_userReturn all cPanel account unique email recipients get_user_email_forward_destinationReturn cPanel account forward destination hold_outgoing_emailAdd cPanel account to outbound email hold queue install_dkim_private_keysInstall existing private key to DKIM record install_spf_recordsInstall domain SPF record is_sni_supportedReturn server SNI support status list_blocked_incoming_email_countriesReturn blocked email countries list list_blocked_incoming_email_domainsReturn blocked email domains list list_pops_forReturn cPanel account's email accounts mail_sni_statusReturn domain's SNI mail services status normalize_user_email_configurationRepair misconfigured email settings rebuild_mail_sni_configRebuild mail SNI configuration files release_outgoing_emailRelease cPanel account queued outgoing emails remove_dmarcRemove domains' DMARC records.save_spamd_configUpdate Apache SpamAssassin™ configuration set_default_dmarc_recordSet the server's default DMARC record set_manual_mx_redirectsAdd manual mail exchanger redirect record set_user_email_forward_destinationUpdate cPanel account email forward destination suspend_outgoing_emailSuspend cPanel account outgoing email terminate_cpuser_mailbox_sessionsStop cPanel account IMAP and POP3 connections unblock_incoming_email_from_countryRemove block on emails from specific countries unblock_incoming_email_from_domainRemove block on emails from specific domains unset_manual_mx_redirectsRemove manual mail exchanger redirect record unsuspend_outgoing_emailUnsuspend account outgoing email validate_current_dkimsValidate DKIM records validate_current_dmarcsValidate DMARC records validate_current_installed_exim_configValidate Exim configuration validate_current_ptrsValidate domain PTR records validate_current_spfsValidate domain SPF records validate_exim_configuration_syntaxValidate Exim configure file syntax

Market9

disable_market_providerDisable Market provider enable_market_providerEnable Market provider get_adjusted_market_providers_productsReturn Market providers' products adjusted prices get_market_providers_commission_configReturn Market providers' commission configuration get_market_providers_listReturn Market providers get_market_providers_product_metadataReturn Market providers' products metadata get_market_providers_productsReturn Market providers products set_market_product_attributeUpdate Market provider product set_market_provider_commission_idUpdate Market provider commission contact ID

ModSecurity38

NGINX Manager6

nginxmanager_clear_cacheDelete the user's NGINX cache.nginxmanager_get_cache_config_systemReturn NGINX caching configurations.nginxmanager_get_cache_config_usersReturn user NGINX caching configurations.nginxmanager_rebuild_cache_configUpdate NGINX configuration.nginxmanager_reset_users_cache_configRestore NGINX configuration to default values.nginxmanager_set_cache_configUpdate NGINX caching status.

Packages26

_getpkgextensionformReturn hosting plan extension templates add_override_features_for_userAdd cPanel account feature list overrides addpkgCreate hosting plan addpkgextAdd hosting plan extension changepackageUpdate user hosting plan create_featurelistCreate feature list delete_featurelistDelete feature list delpkgextRemove hosting plan extension editpkgUpdate hosting plan get_available_applicationsReturn dynamicui file get_available_featurelists(Deprecated) Get available feature lists get_feature_metadataReturn current user's available feature lists info get_feature_namesReturn all features get_featurelist_dataReturn feature list configuration get_featurelistsReturn current user's available feature lists get_featurelists_by_package_typesReturn feature lists by package type get_users_features_settingsReturn cPanel accounts' feature settings getpkginfoReturn hosting plan configuration killpkgDelete hosting plan listpkgsReturn current user's available hosting plans manage_featuresUpdate Feature Showcase matchpkgsReturn filtered hosting plans read_featurelist(Deprecated) Read feature list settings remove_override_features_for_userRemove cPanel account feature list overrides update_featurelistUpdate feature list verify_user_has_featureReturn cPanel account feature access

Passwords3

forcepasswordchangeEnable forced password update get_password_strengthReturn password strength passwdUpdate cPanel account password

PHP14

php_get_handlersReturn PHP handlers php_get_impacted_domainsReturn PHP preconfigured domains php_get_installed_versionsReturn installed PHP versions php_get_system_default_versionReturn system default PHP version php_get_vhost_versionsReturn PHP version of all virtual hosts php_get_vhosts_by_versionReturn virtual hosts per PHP version php_ini_get_contentReturn PHP version's php.ini file php_ini_get_directivesReturn PHP version's directives php_ini_set_contentUpdate PHP version's php.ini file php_ini_set_directivesUpdate PHP version's directives php_set_handlerUpdate PHP version's handler php_set_session_save_pathUpdate PHP default save path php_set_system_default_versionUpdate default PHP version php_set_vhost_versionsUpdate domain's PHP values

PHP-FPM9

convert_all_domains_to_fpmEnable PHP-FPM on all domains get_fpm_count_and_utilizationReturn workload data for PHP-FPM on all domains is_conversion_in_progressReturn PHP-FPM conversion status php_fpm_config_getReturn PHP-FPM directives and pool options php_fpm_config_setUpdate PHP-FPM directives and pool options php_get_default_accounts_to_fpmReturn PHP-FPM status on new accounts php_get_old_fpm_flagReturn PHP-FPM preconfigured status php_set_default_accounts_to_fpmEnable PHP-FPM on new cPanel accounts and domains php_set_old_fpm_flagEnable PHP-FPM preconfigured status

Plugin-Based Features3

is_readyCheck if a plugin feature is ready for use local_disableDisable feature locally local_enableEnable feature locally

Resellers21

acctcountsReturn reseller's owned accounts' information get_public_contactReturn current user's public contact information getreselleripsReturn reseller's available IP addresses list_enhancement_limitsReturn account enhancement limits listaclsReturn all privilege lists and settings listresellersReturn all resellers resellerstatsReturn reseller's information saveacllistCreate or update privilege list and settings set_enhancement_limitUpdate account enhancement limit set_public_contactUpdate current user's public contact information setaclsCreate or update reseller privilege settings setreselleripsAdd IP addresses to reseller setresellerlimitsUpdate reseller's bandwidth and disk quotas setresellermainipUpdate reseller's main IP address setresellernameserversUpdate reseller's assigned nameservers setresellerpackagelimitUpdate reseller's hosting plan limits setupresellerEnable cPanel account's reseller status suspendresellerSuspend reseller terminateresellerDelete reseller and reseller's cPanel accounts unsetupresellerDisables cPanel account's reseller status unsuspendresellerUnsuspend reseller

RPM14

delete_rpm_versionRemove rpm.versions system configuration edit_rpm_versionUpdate rpm.versions system configuration get_rpm_version_dataReturn available RPM packages install_rpm_pluginInstall WHM plugin RPM package list_rpmsReturn required but uninstalled server RPM package package_manager_fixcacheRepair RPM management yum cache issues package_manager_get_build_logReturn RPM management build log package_manager_get_package_infoReturn available RPM packages information package_manager_is_performing_actionsReturn RPM package update status package_manager_list_packagesReturn available RPM packages package_manager_resolve_actionsReturn possible RPM package changes package_manager_submit_actionsStart RPM package installation, update, or removal package_manager_upgradeStart RPM package upgrade uninstall_rpm_pluginUninstall WHM plugin RPM package

Script Hooks4

delete_hookDelete script hook edit_hookUpdate script hook list_hooksReturn script hooks list reorder_hooksUpdate script hooks order

Security3

fetch_security_adviceReturn Security Advisor results getminimumpasswordstrengthsReturn minimum password strength setminimumpasswordstrengthsUpdate minimum password strength

Server Administration64

add_configclusterserverAdd configuration cluster server configurebackgroundprocesskillerUpdate background process stopper configureserviceEnable or disable a service and its monitoring create_user_sessionCreate a temporary user session delete_configclusterserverDelete server from configuration cluster enable_monitor_all_enabled_servicesEnable monitoring for all services fetch_connected_applicationFetch application connection information force_dedistribution_from_nodeRepair distributed accounts with data loss get_all_contact_importancesReturn Contact Manager event importance settings get_api_callsReturn deprecated cPanel API 1 functions by date get_api_pagesReturn deprecated cPanel API 1 functions get_appconfig_application_listReturn registered applications get_application_contact_event_importanceReturn app's event contact importance setting get_application_contact_importanceReturn app contact importance setting get_available_profilesReturn available server profiles get_current_profileReturn server's node profile get_linked_server_nodeReturn linked remote server node settings get_remote_access_hashReturn remote access file's hash get_server_node_statusReturn linked server node status get_service_configReturn service configuration settings get_service_config_keyReturn service configuration key get_tcp4_socketsReturn TCP IPv4 sockets data get_tcp6_socketsReturn TCP IPv6 sockets data get_udp4_socketsReturn UDP IPv4 sockets data get_udp6_socketsReturn UDP IPv6 sockets data get_update_availabilityReturn if server uses the default update version getdiskusageReturn server's drive partition information gethostnameReturn server's hostname is_role_enabledReturn whether server role is enabled link_server_node_with_api_tokenAdd linked server node list_configclusterserversReturn all configuration cluster servers list_connected_applicationsList application connection information list_linked_server_nodesReturn all linked server nodes list_user_child_nodesReturn cPanel accounts with server name and type personalization_getReturn data from NVData file personalization_setSave data to NVData file purchase_a_licenseReturn cPanel Store or Market checkout URL rebootRestart server remove_connected_applicationRemove application connection information remove_in_progress_exim_config_editRemove Exim configuration files after failed update restartserviceRestart service restore_config_from_fileUpdate configuration file from backup restore_config_from_uploadUpdate configuration file from backup via POST run_cpkeycltReturn server's cPanel license status save_connected_applicationSave application connection information.send_test_posturlSend notification URL via POST send_test_pushbullet_noteSend Pushbullet™ test with access token servicestatusReturn service status set_application_contact_event_importanceUpdate app's event contact importance setting set_application_contact_importanceUpdate app contact importance setting set_primary_servernameUpdate server's primary virtual host set_service_config_keyUpdate service configuration key sethostnameUpdate server's hostname start_cpanel_updateStart cPanel & WHM update start_profile_activationUpdate server node profile system_needs_rebootReturn whether system needs reboot systemloadavgReturn system load average unlink_server_nodeRemove linked server node update_configclusterserverUpdate configuration cluster server credentials update_contact_emailUpdate WHM contact email address update_linked_server_nodeUpdate linked server node settings verify_posturl_accessSend notification URL via POST verification verify_pushbullet_accessSend Pushbullet™ access verification verify_slack_accessVerify Slack® Webhook connection

Services3

get_service_proxy_backendsReturn a cPanel account’s service proxying setup set_service_proxy_backendsUpdate cPanel account service proxying unset_all_service_proxy_backendsRemove cPanel account service proxying

Sitejet4

get_commerceGet Commerce Data get_ecommerceGet Ecommerce Data set_commerceSet Commerce URL set_ecommerceSet Ecommerce URL

SSH Keys and Connections8

accesshashReturn cPanel account access hash authorizesshkeyEnable SSH key for server check_remote_ssh_connectionValidate SSH connection to another server convertopensshtoputtyMigrate OpenSSH key to PuTTY format deletesshkeyDelete SSH key generatesshkeypairCreate SSH key pair importsshkeyImport SSH key listsshkeysReturn SSH keys list

SSL34

add_autossl_user_excluded_domainsDisable AutoSSL for domain delete_ssl_vhostDelete SSL vhost disable_autosslDisable AutoSSL enqueue_deferred_ssl_installationsAdd SSL certificate to installation queue fetch_service_ssl_componentsReturn system services and associated certificates fetch_ssl_certificates_for_fqdnsReturn cPanel account FQDN certificate information fetch_ssl_vhostsReturn server vhosts and SSL certificates fetch_vhost_ssl_componentsReturn all SSL certificate components on vhost fetchcrtinfoReturn SSL certificate information fetchsslinfoReturn cPanel account SSL certificate information generatesslCreate self-signed SSL certificate get_autossl_check_scheduleReturn AutoSSL check script cron entry get_autossl_logReturn AutoSSL log file's contents get_autossl_logs_catalogReturn AutoSSL log files get_autossl_metadataReturn current user's AutoSSL metadata get_autossl_problems_for_domainReturn domain DCV issues get_autossl_problems_for_userReturn account DCV issues get_autossl_providersReturn available AutoSSL providers get_autossl_user_excluded_domainsReturn all AutoSSL-excluded domains get_best_ssldomain_for_serviceReturn SSL-encrypted domain for service access install_service_ssl_certificateInstall SSL certificate for service installsslInstall SSL certificate listcrtsReturn domains with installed SSL certificates rebuildinstalledssldbRebuild installed SSL database (no-op)rebuilduserssldbUpdate SSL certificate users database remove_autossl_user_excluded_domainsRemove AutoSSL for domain reset_autossl_providerRestore AutoSSL registration reset_service_ssl_certificateCreate self-signed SSL certificate for service set_autossl_metadataUpdate AutoSSL metadata set_autossl_metadata_keyUpdate AutoSSL metadata via JSON set_autossl_providerUpdate the AutoSSL provider set_autossl_user_excluded_domainsDisable AutoSSL for domain start_autossl_check_for_all_usersStart AutoSSL check for all cPanel accounts start_autossl_check_for_one_userStart cPanel account AutoSSL check

Styles1

get_users_linksReturn cPanel account theme's app keys and URLs

Support Tickets14

ticket_create_stub_ticketCreate initial Support ticket request ticket_get_support_agreementImport Technical Support Agreement text ticket_get_support_infoImport customer information from Customer Portal ticket_grantCreate Support SSH key ticket_listReturn Support ticket status ticket_remove_closedDelete Support SSH key and closed tickets ticket_revokeDelete Support SSH key ticket_ssh_testValidate Customer Portal connection ticket_ssh_test_startValidate Support SSH connection ticket_update_service_agreement_approvalEnable Technical Support Agreement acceptance ticket_validate_oauth2_codeValidate Customer Portal OAuth2 code ticket_whitelist_checkValidate Support IP addresses on firewall ticket_whitelist_setupAdd Support IP addresses to firewall ticket_whitelist_unsetupRemove Support IP addresses from firewall

Suspensions4

listlockedaccountsReturn suspended cPanel accounts listsuspendedReturn suspended cPanel accounts and information suspendacctSuspend cPanel account unsuspendacctUnsuspend cPanel account

Transfers15

abort_transfer_sessionStop transfer session analyze_transfer_session_remoteValidate remote server's credentials available_transfer_modulesReturn available transfer modules create_remote_root_transfer_sessionCreate remote server transfer session as root user create_remote_user_transfer_sessionCreate remote server transfer session delete_account_archivesRemove cPanel account's archives enqueue_transfer_itemAdd module to transfer session fetch_transfer_session_logReturn transfer session's log file get_transfer_session_stateReturn transfer session's status pause_transfer_sessionSuspend active transfer session remote_basic_credential_checkValidate remote server's SSH credentials retrieve_transfer_session_remote_analysisReturn transfer session's information start_transfer_sessionStart or restart transfer session transfer_module_schemaReturn a transfer module's schema validate_system_userValidate username availability on target server

Updates9

accept_eulaSave EULA acceptance get_available_tiersReturn cPanel & WHM available versions get_current_lts_expiration_statusReturn Long Term Support expiration status get_lts_wexpireReturn Long Term Support status for all versions installed_versionsReturn third-party software versions set_cpanel_updatesUpdate cPanel & WHM update frequency set_tierUpdate cPanel & WHM release tier update_updateconfUpdate software update behavior versionReturn cPanel & WHM version

UserData2

get_scoped_userdataGet scoped userdata set_scoped_userdataSet scoped userdata

Web Log Retention1

list_accounts_retentionList accounts' web log retention settings

WHM Access2

allow_all_whm_root_accessClear all CIDR restrictions to login to cPanel & WHM with the root password.restrict_whm_root_accessRestrict Access to WHM by CIDR list.

How to use this index

The pages do not expose Hostilla.pl credentials or API tokens. They are a technical map for customers, resellers and support teams who automate cPanel/WHM tasks or need to identify the right API command before contacting support.

Access and safety

UAPI commands usually run in the context of a cPanel account. WHM API commands require reseller or administrative privileges. API tokens should be limited to the required scope and never pasted into public tickets, screenshots or e-mail.