WHM API 1
WHM API 1 is the HTTP API for server-wide and reseller-level operations on a cPanel & WHM server: creating, suspending, restoring and terminating cPanel accounts, managing hosting packages and feature lists, DNS and DNSSEC, AutoSSL and certificate installation, backups and backup destinations, transfers, ModSecurity, cPHulk and API tokens. 625 operations served at /json-api/{function} on ports 2087 (secure) and 2086, or 443 through a service subdomain. Every call requires api.version=1 and an 'Authorization: whm :' header; every call returns HTTP 200 with the outcome in metadata.result.
WHM API 1 is one of 4 APIs that cPanel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account, Packages, Reseller, Server Administration, and WHM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes 625 operations across 625 paths, organized into 49 resource areas, and defines 155 schemas. It is described by OpenAPI 3.0.2, at version 11.137.9999.106.
Requests are made against a single base URL, https://{host}:{port}/json-api.
625 operations
625 paths
155 schemas
606 GET19 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
WHM API 1 declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 625
Across 625 paths, the API surfaces 625 operations — 606 GET, 19 POST. They span 49 resource areas, including 360 Monitoring, Plugin-Based Features, Packages, Transfers, Updates, SSH Keys and Connections, Accounts, Resellers, and 41 more. Each is listed below with its method, path, parameters, and response codes.
360 Monitoring 2
The 360 Monitoring module for WHM API 1.
GET
/360Monitoring/register_server_with_360_monitoring
Register the server with 360 Monitoring
GET
/360Monitoring/set_360_agent_polling
Update 360 Monitoring agent polling settings
Plugin-Based Features 3
The plugin-based features module for WHM API 1.
GET
/EcosystemFeatures/is_ready
Check if a plugin feature is ready for use
GET
/EcosystemFeatures/local_disable
Disable feature locally
GET
/EcosystemFeatures/local_enable
Enable feature locally
Packages 26
The Packages module for WHM API 1.
GET
/_getpkgextensionform
Return hosting plan extension templates
GET
/add_override_features_for_user
Add cPanel account feature list overrides
GET
/addpkg
Create hosting plan
GET
/addpkgext
Add hosting plan extension
GET
/changepackage
Update user hosting plan
GET
/create_featurelist
Create feature list
GET
/delete_featurelist
Delete feature list
GET
/delpkgext
Remove hosting plan extension
GET
/editpkg
Update hosting plan
GET
/get_available_applications
Return dynamicui file
GET
/get_available_featurelistsdeprecated
(Deprecated) Get available feature lists
GET
/get_feature_metadata
Return current user's available feature lists info
GET
/get_feature_names
Return all features
GET
/get_featurelist_data
Return feature list configuration
GET
/get_featurelists
Return current user's available feature lists
GET
/get_featurelists_by_package_types
Return feature lists by package type
GET
/get_users_features_settings
Return cPanel accounts' feature settings
GET
/getpkginfo
Return hosting plan configuration
GET
/killpkg
Delete hosting plan
GET
/listpkgs
Return current user's available hosting plans
GET
/manage_features
Update Feature Showcase
GET
/matchpkgs
Return filtered hosting plans
GET
/read_featurelistdeprecated
(Deprecated) Read feature list settings
GET
/remove_override_features_for_user
Remove cPanel account feature list overrides
GET
/update_featurelist
Update feature list
GET
/verify_user_has_feature
Return cPanel account feature access
Transfers 15
The Transfers module for WHM API 1.
GET
/abort_transfer_session
Stop transfer session
GET
/analyze_transfer_session_remote
Validate remote server's credentials
GET
/available_transfer_modules
Return available transfer modules
GET
/create_remote_root_transfer_session
Create remote server transfer session as root user
GET
/create_remote_user_transfer_session
Create remote server transfer session
GET
/delete_account_archives
Remove cPanel account's archives
GET
/enqueue_transfer_item
Add module to transfer session
GET
/fetch_transfer_session_log
Return transfer session's log file
GET
/get_transfer_session_state
Return transfer session's status
GET
/pause_transfer_session
Suspend active transfer session
GET
/remote_basic_credential_check
Validate remote server's SSH credentials
GET
/retrieve_transfer_session_remote_analysis
Return transfer session's information
GET
/start_transfer_session
Start or restart transfer session
GET
/transfer_module_schema
Return a transfer module's schema
GET
/validate_system_user
Validate username availability on target server
Updates 9
Server Administration / Updates
GET
/accept_eula
Save EULA acceptance
GET
/get_available_tiers
Return cPanel & WHM available versions
GET
/get_current_lts_expiration_status
Return Long Term Support expiration status
GET
/get_lts_wexpire
Return Long Term Support status for all versions
GET
/installed_versions
Return third-party software versions
GET
/set_cpanel_updates
Update cPanel & WHM update frequency
GET
/set_tier
Update cPanel & WHM release tier
POST
/update_updateconf
Update software update behavior
GET
/version
Return cPanel & WHM version
SSH Keys and Connections 8
Authentication / SSH Keys and Connections
GET
/accesshashdeprecated
Return cPanel account access hash
GET
/authorizesshkey
Enable SSH key for server
GET
/check_remote_ssh_connection
Validate SSH connection to another server
GET
/convertopensshtoputty
Migrate OpenSSH key to PuTTY format
GET
/deletesshkey
Delete SSH key
GET
/generatesshkeypair
Create SSH key pair
GET
/importsshkey
Import SSH key
GET
/listsshkeys
Return SSH keys list
Accounts 10
The Accounts module for WHM API 1.
GET
/accountsummary
Return cPanel account summary
GET
/get_upgrade_opportunities
Get upgrade opportunities
GET
/has_digest_auth
Validate cPanel account Digest Authentication
GET
/has_mycnf_for_cpuser
Validate MySQL Configuration file
GET
/listaccts
Return cPanel accounts
GET
/massmodifyacct
Update multiple cPanel accounts
GET
/modifyacct
Update cPanel account
GET
/myprivs
Return cPanel account system privileges
GET
/set_digest_auth
Enable or disable Digest Authentication
GET
/untrack_acct_id
Remove UID or GID from tracked list
Resellers 21
The Resellers module for WHM API 1.
GET
/acctcounts
Return reseller's owned accounts' information
GET
/get_public_contact
Return current user's public contact information
GET
/getresellerips
Return reseller's available IP addresses
GET
/list_enhancement_limits
Return account enhancement limits
GET
/listacls
Return all privilege lists and settings
GET
/listresellers
Return all resellers
GET
/resellerstats
Return reseller's information
GET
/saveacllist
Create or update privilege list and settings
GET
/set_enhancement_limit
Update account enhancement limit
GET
/set_public_contact
Update current user's public contact information
GET
/setacls
Create or update reseller privilege settings
GET
/setresellerips
Add IP addresses to reseller
GET
/setresellerlimits
Update reseller's bandwidth and disk quotas
GET
/setresellermainip
Update reseller's main IP address
GET
/setresellernameservers
Update reseller's assigned nameservers
GET
/setresellerpackagelimit
Update reseller's hosting plan limits
GET
/setupreseller
Enable cPanel account's reseller status
GET
/suspendreseller
Suspend reseller
GET
/terminatereseller
Delete reseller and reseller's cPanel accounts
GET
/unsetupreseller
Disables cPanel account's reseller status
GET
/unsuspendreseller
Unsuspend reseller
DNS 44
The DNS module for WHM API 1.
GET
/activate_zone_key
Enable domain's DNSSEC key
GET
/add_zone_key
Create domain's DNSSEC zone key
GET
/adddns
Create DNS zone
POST
/addzonerecord
Create DNS zone record
GET
/cluster_member_has_trust_with
Return whether DNS cluster server can share records
GET
/create_parked_domain_for_user
Create domain alias
GET
/create_subdomain
Create subdomain
GET
/deactivate_zone_key
Disable domain's DNSSEC key
GET
/delete_domain
Delete domain
GET
/disable_dnssec_for_domains
Disable DNSSEC on domain
GET
/dumpzonedeprecated
Return domain's DNS zone configuration
POST
/editzonerecord
Update DNS zone record
GET
/enable_dnssec_for_domains
Enable DNSSEC on domain
GET
/export_zone_dnskey
Export domain's DNSKEY record value
GET
/export_zone_files
Export DNS zones in zone file format
GET
/export_zone_key
Export domain's DNSSEC key
GET
/fetch_ds_records_for_domains
Return domain's DS record
GET
/get_nameserver_config
Return current user's nameservers
GET
/getzonerecord
Return specific line from domain's DNS configuration
GET
/has_local_authority
Validate local server is authoritative
GET
/import_zone_key
Import DNSSEC key
GET
/is_alias_available
Return ALIAS DNS record availability & resolver
GET
/is_https_available
Return HTTPS DNS record support information
GET
/is_svcb_available
Return SVCB DNS record support information
GET
/killdns
Delete DNS zone
GET
/listmxs
Return domain's mail exchanger records
GET
/listzones
Return server's DNS zones
GET
/lookupnsip
Return nameserver's IP address
GET
/lookupnsips
Return nameserver's IPv4 and IPv6 addresses
GET
/mass_edit_dns_zone
Update a DNS zone
GET
/parse_dns_zone
Return a parsed DNS zone
GET
/remove_zone_key
Remove DNSSEC key
GET
/removezonerecord
Delete DNS zone record
GET
/resetzone
Restore DNS zone to default values
GET
/resolvedomainname
Return domain's IP address
GET
/savemxs
Create mail exchanger record
GET
/set_nameserver
Update remote DNS server's nameserver software
GET
/set_nsec3_for_domains
Enable NSEC3 semantics for domain
GET
/set_up_dns_resolver_workarounds
Create unbound DNS resolver
GET
/setresolvers
Update server's resolver nameservers
GET
/unset_nsec3_for_domains
Enable NSEC semantics for domain
GET
/update_nameservers_config
Update default nameservers
GET
/update_reverse_dns_cache
Update reverse DNS cache
GET
/updateuserdomains
Update /etc/userdomains file
SSL 34
The SSL module for WHM API 1.
GET
/add_autossl_user_excluded_domains
Disable AutoSSL for domain
GET
/delete_ssl_vhost
Delete SSL vhost
GET
/disable_autossl
Disable AutoSSL
GET
/enqueue_deferred_ssl_installations
Add SSL certificate to installation queue
GET
/fetch_service_ssl_components
Return system services and associated certificates
GET
/fetch_ssl_certificates_for_fqdns
Return cPanel account FQDN certificate information
GET
/fetch_ssl_vhosts
Return server vhosts and SSL certificates
GET
/fetch_vhost_ssl_components
Return all SSL certificate components on vhost
GET
/fetchcrtinfo
Return SSL certificate information
GET
/fetchsslinfo
Return cPanel account SSL certificate information
GET
/generatessl
Create self-signed SSL certificate
GET
/get_autossl_check_schedule
Return AutoSSL check script cron entry
GET
/get_autossl_log
Return AutoSSL log file's contents
GET
/get_autossl_logs_catalog
Return AutoSSL log files
GET
/get_autossl_metadata
Return current user's AutoSSL metadata
GET
/get_autossl_problems_for_domain
Return domain DCV issues
GET
/get_autossl_problems_for_user
Return account DCV issues
GET
/get_autossl_providers
Return available AutoSSL providers
GET
/get_autossl_user_excluded_domains
Return all AutoSSL-excluded domains
GET
/get_best_ssldomain_for_service
Return SSL-encrypted domain for service access
GET
/install_service_ssl_certificate
Install SSL certificate for service
GET
/installssl
Install SSL certificate
GET
/listcrts
Return domains with installed SSL certificates
GET
/rebuildinstalledssldb
Rebuild installed SSL database (no-op)
GET
/rebuilduserssldb
Update SSL certificate users database
GET
/remove_autossl_user_excluded_domains
Remove AutoSSL for domain
GET
/reset_autossl_provider
Restore AutoSSL registration
GET
/reset_service_ssl_certificate
Create self-signed SSL certificate for service
GET
/set_autossl_metadata
Update AutoSSL metadata
GET
/set_autossl_metadata_key
Update AutoSSL metadata via JSON
GET
/set_autossl_provider
Update the AutoSSL provider
GET
/set_autossl_user_excluded_domains
Disable AutoSSL for domain
GET
/start_autossl_check_for_all_users
Start AutoSSL check for all cPanel accounts
GET
/start_autossl_check_for_one_user
Start cPanel account AutoSSL check
Server Administration 66
The Server Administration module for WHM API 1.
POST
/add_configclusterserver
Add configuration cluster server
GET
/configurebackgroundprocesskiller
Update background process stopper
GET
/configureservice
Enable or disable a service and its monitoring
GET
/create_user_session
Create a temporary user session
GET
/delete_configclusterserver
Delete server from configuration cluster
GET
/enable_monitor_all_enabled_services
Enable monitoring for all services
POST
/fetch_connected_application
Fetch application connection information
GET
/force_dedistribution_from_node
Repair distributed accounts with data loss
GET
/get_all_contact_importances
Return Contact Manager event importance settings
GET
/get_api_calls
Return deprecated cPanel API 1 functions by date
GET
/get_api_pages
Return deprecated cPanel API 1 functions
GET
/get_appconfig_application_list
Return registered applications
GET
/get_application_contact_event_importance
Return app's event contact importance setting
GET
/get_application_contact_importance
Return app contact importance setting
GET
/get_available_profiles
Return available server profiles
GET
/get_current_profile
Return server's node profile
GET
/get_linked_server_node
Return linked remote server node settings
GET
/get_remote_access_hashdeprecated
Return remote access file's hash
GET
/get_server_node_status
Return linked server node status
GET
/get_service_config
Return service configuration settings
GET
/get_service_config_key
Return service configuration key
GET
/get_tcp4_sockets
Return TCP IPv4 sockets data
GET
/get_tcp6_sockets
Return TCP IPv6 sockets data
GET
/get_udp4_sockets
Return UDP IPv4 sockets data
GET
/get_udp6_sockets
Return UDP IPv6 sockets data
GET
/get_update_availability
Return if server uses the default update version
GET
/getdiskusage
Return server's drive partition information
GET
/gethostname
Return server's hostname
GET
/is_role_enabled
Return whether server role is enabled
GET
/link_server_node_with_api_token
Add linked server node
GET
/list_configclusterservers
Return all configuration cluster servers
POST
/list_connected_applications
List application connection information
GET
/list_linked_server_nodes
Return all linked server nodes
GET
/list_user_child_nodes
Return cPanel accounts with server name and type
POST
/personalization_get
Return data from NVData file
POST
/personalization_set
Save data to NVData file
GET
/purchase_a_license
Return cPanel Store or Market checkout URL
GET
/reboot
Restart server
POST
/remove_connected_application
Remove application connection information
GET
/remove_in_progress_exim_config_edit
Remove Exim configuration files after failed update
GET
/restartservice
Restart service
GET
/restore_config_from_file
Update configuration file from backup
POST
/restore_config_from_upload
Update configuration file from backup via POST
GET
/run_cpkeyclt
Return server's cPanel license status
POST
/save_connected_application
Save application connection information.
GET
/send_test_posturl
Send notification URL via POST
GET
/send_test_pushbullet_note
Send Pushbullet™ test with access token
GET
/servicestatus
Return service status
GET
/set_application_contact_event_importance
Update app's event contact importance setting
GET
/set_application_contact_importance
Update app contact importance setting
GET
/set_primary_servername
Update server's primary virtual host
GET
/set_service_config_key
Update service configuration key
GET
/sethostname
Update server's hostname
GET
/start_cpanel_update
Start cPanel & WHM update
GET
/start_profile_activation
Update server node profile
GET
/system_needs_reboot
Return whether system needs reboot
GET
/systemloadavg
Return system load average
GET
/unlink_server_node
Remove linked server node
GET
/update_configclusterserver
Update configuration cluster server credentials
GET
/update_contact_email
Update WHM contact email address
GET
/update_linked_server_node
Update linked server node settings
GET
/verify_posturl_access
Send notification URL via POST verification
GET
/verify_pushbullet_access
Send Pushbullet™ access verification
GET
/verify_slack_access
Verify Slack® Webhook connection
GET
/wp_dashboard_create_login_link
Create login link for Dashboard
GET
/wp_dashboard_get_hostname
Return server's hostname
IP Addresses 16
The IP Addresses module for WHM API 1.
GET
/addips
Add IP addresses
GET
/delip
Remove IP address
GET
/get_public_ip
Return public IP address of private IP address
GET
/get_shared_ip
Return shared IP address
GET
/ipv6_disable_account
Remove IPv6 address range from account
GET
/ipv6_enable_account
Add IPv6 address range to accounts
GET
/ipv6_range_add
Add IPv6 address range
GET
/ipv6_range_edit
Update IPv6 address range name or note
GET
/ipv6_range_list
Return available IPv6 address ranges
GET
/ipv6_range_remove
Remove IPv6 address range
GET
/ipv6_range_usage
Return IPv6 address usage
GET
/listips
Return server's IP addresses
GET
/listipv6s
Return server's IPv6 addresses
GET
/nat_checkip
Validate public IP address for NAT
GET
/nat_set_public_ip
Register NAT IP address to public IP address
GET
/setsiteip
Update domain or cPanel account IP address
WHM Access 2
Security / WHM Access
GET
/allow_all_whm_root_access
Clear all CIDR restrictions to login to cPanel & WHM with the root password.
GET
/restrict_whm_root_access
Restrict Access to WHM by CIDR list.
Authentication 31
The Authentication module for WHM API 1.
GET
/api_token_create
Create WHM API token
GET
/api_token_get_details
Look up API token details
GET
/api_token_list
Return WHM API tokens
GET
/api_token_revoke
Disable WHM API token
GET
/api_token_update
Update WHM API token's settings
GET
/disable_authentication_provider
Disable identity provider
GET
/disable_failing_authentication_providers
Disable identity provider modules that fail to load
GET
/enable_authentication_provider
Enable identity provider
GET
/get_available_authentication_providers
Return available identity providers
GET
/get_login_url
Return cPanel Store or cPanel Market login URL
GET
/get_provider_client_configurations
Return identity provider client configuration
GET
/get_provider_configuration_fields
Return identity provider configuration fields
GET
/get_provider_display_configurations
Return identity provider login interface appearance
GET
/get_users_authn_linked_accounts
Return accounts linked to identity providers
GET
/link_user_authn_provider
Add identity provider to cPanel account
GET
/set_provider_client_configurations
Update identity provider client configuration
GET
/set_provider_display_configurations
Update identity provider login interface appearance
GET
/twofactorauth_disable_policy
Disable 2FA
GET
/twofactorauth_enable_policy
Enable 2FA
GET
/twofactorauth_generate_tfa_config
Create a one-time authentication secret and code
GET
/twofactorauth_get_issuer
Return configured issuer for current user
GET
/twofactorauth_get_tfa_config_for_user
Return cPanel account 2FA data
GET
/twofactorauth_get_user_configs
Return cPanel accounts with 2FA enabled
GET
/twofactorauth_policy_status
Return 2FA policy status
GET
/twofactorauth_remove_user_config
Remove 2FA settings
GET
/twofactorauth_set_issuer
Update 2FA issuer value
GET
/twofactorauth_set_tfa_config
Update 2FA authentication secret and code
POST
/twofactorauth_set_tfa_config_for_user
Update cPanel account's 2FA data
GET
/unlink_user_authn_provider
Unregister cPanel account from authentication provider
GET
/validate_login_token
Validate login token and return access token
GET
/wp_dashboard_create_api_token
Create API token for Dashboard
Applications 1
API Development Tools / Applications
GET
/applist
Return WHM API 1 functions list
Mail 51
The Mail module for WHM API 1.
GET
/apply_dmarc
Apply a DMARC record to a domain
GET
/block_incoming_email_from_country
Add block on emails from specific countries
GET
/block_incoming_email_from_domain
Add block on emails from specific domains
GET
/disable_dkim
Disable domain's DKIM records
GET
/disable_mail_snideprecated
(Deprecated) Disable SNI mail services for domains
GET
/emailtrack_search
Return email delivery records by search criteria
GET
/emailtrack_stats
Return cPanel account email tracking statistics
GET
/emailtrack_user_stats
Return all cPanel accounts email tracking statistics
GET
/enable_dkim
Enable domain's DKIM records
GET
/enable_mail_sni
Enable SNI mail services for domains
GET
/ensure_dkim_keys_exist
Validate domain's DKIM keys
GET
/exim_configuration_check
Repair Exim configuration file
GET
/expunge_mailbox_messages
Remove email account messages by Dovecot query
GET
/expunge_messages_for_mailbox_guid
Remove email account messages by mailbox GUID
GET
/fetch_dkim_private_keys
Return domain's DKIM private key
GET
/fetch_mail_queue
Return server mail queue contents
GET
/generate_mobileconfig
Create email account mobile profile configuration
GET
/get_default_dmarc_record
Get the server's default DMARC record
GET
/get_mailbox_status
Return cPanel account mailboxes status by name
GET
/get_mailbox_status_list
Return cPanel account mailboxes status list
GET
/get_unique_recipient_count_per_sender_for_user
Return cPanel account unique email recipients
GET
/get_unique_sender_recipient_count_per_user
Return all cPanel account unique email recipients
GET
/get_user_email_forward_destination
Return cPanel account forward destination
GET
/hold_outgoing_email
Add cPanel account to outbound email hold queue
GET
/install_dkim_private_keys
Install existing private key to DKIM record
GET
/install_spf_records
Install domain SPF record
GET
/is_sni_supported
Return server SNI support status
GET
/list_blocked_incoming_email_countries
Return blocked email countries list
GET
/list_blocked_incoming_email_domains
Return blocked email domains list
GET
/list_pops_for
Return cPanel account's email accounts
GET
/mail_sni_status
Return domain's SNI mail services status
GET
/normalize_user_email_configuration
Repair misconfigured email settings
GET
/rebuild_mail_sni_config
Rebuild mail SNI configuration files
GET
/release_outgoing_email
Release cPanel account queued outgoing emails
GET
/remove_dmarc
Remove domains' DMARC records.
GET
/save_spamd_config
Update Apache SpamAssassin™ configuration
GET
/set_default_dmarc_record
Set the server's default DMARC record
GET
/set_manual_mx_redirects
Add manual mail exchanger redirect record
GET
/set_user_email_forward_destination
Update cPanel account email forward destination
GET
/suspend_outgoing_email
Suspend cPanel account outgoing email
GET
/terminate_cpuser_mailbox_sessions
Stop cPanel account IMAP and POP3 connections
GET
/unblock_incoming_email_from_country
Remove block on emails from specific countries
GET
/unblock_incoming_email_from_domain
Remove block on emails from specific domains
GET
/unset_manual_mx_redirects
Remove manual mail exchanger redirect record
GET
/unsuspend_outgoing_email
Unsuspend account outgoing email
GET
/validate_current_dkims
Validate DKIM records
GET
/validate_current_dmarcs
Validate DMARC records
GET
/validate_current_installed_exim_config
Validate Exim configuration
GET
/validate_current_ptrs
Validate domain PTR records
GET
/validate_current_spfs
Validate domain SPF records
GET
/validate_exim_configuration_syntax
Validate Exim configure file syntax
Account Enhancements 6
Accounts / Account Enhancements
GET
/assign_account_enhancement
Assign Account Enhancement
GET
/create_account_enhancement
Create Account Enhancement
GET
/delete_account_enhancement
Remove an Account Enhancement
GET
/list_account_enhancements
Return Account Enhancements
GET
/modify_account_enhancement
Update Account Enhancement
GET
/unassign_account_enhancement
Unassign Account Enhancement
Databases 27
The Databases module for WHM API 1.
GET
/background_mysql_upgrade_checker_run
Validate MySQL status before upgrade
GET
/background_mysql_upgrade_status
Return MySQL or MariaDB upgrade status
GET
/current_mysql_version
Return MySQL version
GET
/get_database_optimizations
Return MySQL database optimizations
GET
/installable_mysql_versions
Return available MySQL versions
GET
/latest_available_mysql_version
Return latest MySQL version
GET
/list_database_users
Return MySQL users
GET
/list_databases
Return MySQL databases
GET
/list_mysql_databases_and_users
Return MySQL databases and users for account
GET
/remote_mysql_create_profile
Create remote MySQL profile
GET
/remote_mysql_create_profile_via_ssh
Create remote MySQL profile via SSH
GET
/remote_mysql_delete_profile
Delete remote MySQL profile
GET
/remote_mysql_initiate_profile_activation
Start remote MySQL profile activation
GET
/remote_mysql_monitor_profile_activation
Return remote MySQL profile activation
GET
/remote_mysql_read_profile
Return remote MySQL profile
GET
/remote_mysql_read_profiles
Return remote MySQL profiles
GET
/remote_mysql_update_profile
Update remote MySQL profile
GET
/remote_mysql_validate_profile
Validate remote MySQL profile connection
GET
/rename_mysql_database
Update MySQL database name
GET
/rename_mysql_user
Update MySQL username
GET
/rename_postgresql_database
Update PostgreSQL database name
GET
/rename_postgresql_user
Update PostgreSQL username
GET
/set_local_mysql_root_password
Update MySQL root password
GET
/set_mysql_password
Update MySQL user password
GET
/set_postgresql_password
Update PostgreSQL user password
GET
/start_background_mysql_upgrade
Start background MySQL upgrade
POST
/update_sql_config
Update the servers SQL configuration.
Backups 27
The Backups module for WHM API 1.
GET
/backup_config_get
Return backup configuration file data
GET
/backup_config_set
Update the system's backup configuration
GET
/backup_date_list
Return dates where backup files exist
GET
/backup_destination_add
Add a backup destination
GET
/backup_destination_delete
Delete a backup destination
GET
/backup_destination_get
Return a backup destination's settings
GET
/backup_destination_list
Return a list of backup destinations
POST
/backup_destination_set
Update backup destination settings
GET
/backup_destination_validate
Validate a backup destination
GET
/backup_does_client_id_have_google_credentials
Return Google Drive™ client ID credentials
GET
/backup_generate_google_oauth_uri
Create Google Drive™ OAuth redirect URI
GET
/backup_get_transport_status
Return backup transport events' status
GET
/backup_list_transported
Return backup files sent through transport
GET
/backup_set_list
Return backup files in the local disk
GET
/backup_set_list_combined
Return backup files for the server's accounts
GET
/backup_skip_users_all
Enable or disable backups
GET
/backup_skip_users_all_status
Return backup configuration status
GET
/backup_user_list
Return users with a backup file
GET
/convert_and_migrate_from_legacy_config
Migrate server to new backup system
GET
/fetch_pkgacct_master_log
Return startbackgroundpkgacct session log file
GET
/get_pkgacct_session_state
Return startbackgroundpkgacct session state
GET
/get_users_and_domains_with_backup_metadata
Return users and domains with backup metadata
GET
/get_users_with_backup_metadata
Return users with backup metadata
GET
/list_cparchive_files
Return cparchive files list
GET
/start_background_pkgacct
Back up an account using the pkgacct script
GET
/start_local_cpmove_restore
Restore one cPanel account from a backup
GET
/toggle_user_backup_state
Enable or disable legacy backups
API Execution 5
The Server Administration module for WHM API 1.
GET
/batch
Run multiple WHM API 1 functions
GET
/cors_proxy_get
Enable CORS HTTP requests
GET
/cpanel
Run cPanel API or UAPI function
GET
/execute_remote_whmapi1_with_password
Run remote WHM API 1 function
GET
/uapi_cpanel
Run UAPI function through WHM API
cPHulk 17
The cPHulk module for WHM API 1.
POST
/batch_create_cphulk_records
Add login security record to list with comment
GET
/cphulk_status
Return login security status
GET
/create_cphulk_record
Add login security record to list
GET
/delete_cphulk_record
Remove login security record from list
GET
/disable_cphulk
Disable login security
GET
/enable_cphulk
Enable login security
GET
/flush_cphulk_login_history
Remove all login security records
GET
/flush_cphulk_login_history_for_ips
Remove login security IP address block
GET
/get_countries_with_known_ip_ranges
Return login security country codes
GET
/get_cphulk_brutes
Return login security brute force attacks
GET
/get_cphulk_excessive_brutes
Return login security excessive brute force attacks
GET
/get_cphulk_failed_logins
Return login security failed logins
GET
/get_cphulk_user_brutes
Return login security brute force attacks by user
GET
/load_cphulk_config
Return login security configuration settings
GET
/read_cphulk_records
Return login security list records
GET
/save_cphulk_config
Save login security configuration settings
GET
/set_cphulk_config_key
Update login security configuration settings
Domain Information 9
Accounts / Domain Domain Information
GET
/convert_addon_fetch_conversion_details
Return additional domain conversion details
GET
/convert_addon_fetch_domain_details
Return additional domain data
GET
/convert_addon_get_conversion_status
Return conversion status for additional domain
GET
/convert_addon_initiate_conversion
Start additional domain conversion
GET
/convert_addon_list_addon_domains
Return current user's additional domains
GET
/convert_addon_list_conversions
Return additional domains conversion queue
GET
/domainuserdata
Return domain user information
GET
/get_domain_info
Return all domains information
GET
/getdomainowner
Return domain owner
PHP-FPM 9
Web Server Configuration / PHP-FPM
GET
/convert_all_domains_to_fpm
Enable PHP-FPM on all domains
GET
/get_fpm_count_and_utilization
Return workload data for PHP-FPM on all domains
GET
/is_conversion_in_progress
Return PHP-FPM conversion status
POST
/php_fpm_config_get
Return PHP-FPM directives and pool options
POST
/php_fpm_config_set
Update PHP-FPM directives and pool options
GET
/php_get_default_accounts_to_fpm
Return PHP-FPM status on new accounts
GET
/php_get_old_fpm_flag
Return PHP-FPM preconfigured status
GET
/php_set_default_accounts_to_fpm
Enable PHP-FPM on new cPanel accounts and domains
GET
/php_set_old_fpm_flag
Enable PHP-FPM preconfigured status
Greylisting 15
The Greylisting module for WHM API 1.
GET
/cpgreylist_is_server_netblock_trusted
Return Greylisting trust status of server netblock
GET
/cpgreylist_list_entries_for_common_mail_provider
Return Greylisting IP addresses of mail providers
GET
/cpgreylist_load_common_mail_providers_config
Return Greylisting mail providers
GET
/cpgreylist_save_common_mail_providers_config
Update Greylisting new mail provider handling
GET
/cpgreylist_status
Return Greylisting status
GET
/cpgreylist_trust_entries_for_common_mail_provider
Add mail provider to Greylisting trusted hosts
GET
/cpgreylist_untrust_entries_for_common_mail_provider
Add mail provider to Greylisting non-trusted hosts
GET
/create_cpgreylist_trusted_host
Add IP address to Greylisting trusted hosts
GET
/delete_cpgreylist_trusted_host
Remove IP address from Greylisting trusted hosts
GET
/disable_cpgreylist
Disable Greylisting
GET
/enable_cpgreylist
Enable Greylisting
GET
/load_cpgreylist_config
Return Greylisting settings
GET
/read_cpgreylist_deferred_entries
Return Greylisting deferred incoming email triplets
GET
/read_cpgreylist_trusted_hosts
Return Greylisting trusted hosts
GET
/save_cpgreylist_config
Update Greylisting settings
Integration 8
The Integration module for WHM API 1.
GET
/create_integration_group
Create integration link group
GET
/create_integration_link
Create integration link
GET
/get_integration_link_user_config
Return integration link configuration
GET
/list_integration_groups
Return integration link groups
GET
/list_integration_links
Return integration links
GET
/remove_integration_group
Remove integration link group
GET
/remove_integration_link
Remove integration link
GET
/update_integration_link_token
Update integration link token
Account Creation 4
Accounts Creation / Accounts
GET
/createacct
Create cPanel account
GET
/get_current_users_count
Return cPanel accounts total number
GET
/get_maximum_users
Return maximum accounts for license
GET
/verify_new_username
Validate new cPanel account username
Customizations 3
The Customizations module for WHM API 1.
GET
/delete_customizations
Delete customization data
GET
/retrieve_customizations
Retrieve customization data
POST
/update_customizations
Update customization data
Script Hooks 4
The Script Hooks module for WHM API 1.
GET
/delete_hook
Delete script hook
GET
/edit_hook
Update script hook
GET
/list_hooks
Return script hooks list
GET
/reorder_hooks
Update script hooks order
RPM 14
The RPM module for WHM API 1.
GET
/delete_rpm_version
Remove rpm.versions system configuration
GET
/edit_rpm_version
Update rpm.versions system configuration
GET
/get_rpm_version_data
Return available RPM packages
GET
/install_rpm_plugin
Install WHM plugin RPM package
GET
/list_rpms
Return required but uninstalled server RPM package
GET
/package_manager_fixcache
Repair RPM management yum cache issues
GET
/package_manager_get_build_log
Return RPM management build log
GET
/package_manager_get_package_info
Return available RPM packages information
GET
/package_manager_is_performing_actions
Return RPM package update status
GET
/package_manager_list_packages
Return available RPM packages
GET
/package_manager_resolve_actions
Return possible RPM package changes
GET
/package_manager_submit_actions
Start RPM package installation, update, or removal
GET
/package_manager_upgrade
Start RPM package upgrade
GET
/uninstall_rpm_plugin
Uninstall WHM plugin RPM package
Market 9
The Market module for WHM API 1.
GET
/disable_market_provider
Disable Market provider
GET
/enable_market_provider
Enable Market provider
GET
/get_adjusted_market_providers_products
Return Market providers' products adjusted prices
GET
/get_market_providers_commission_config
Return Market providers' commission configuration
GET
/get_market_providers_list
Return Market providers
GET
/get_market_providers_product_metadata
Return Market providers' products metadata
GET
/get_market_providers_products
Return Market providers products
GET
/set_market_product_attribute
Update Market provider product
GET
/set_market_provider_commission_id
Update Market provider commission contact ID
EasyApache 7
The EasyApache module for WHM API 1.
GET
/ea4_get_additional_pkg_prefixes
Return any additional package prefixes, beyond ea.
GET
/ea4_get_currently_installed_packages
Return installed Easyapache 4 packages
GET
/ea4_list_profiles
Return EasyApache 4 profiles
GET
/ea4_metainfo
Return ea4-metainfo.json file contents
GET
/ea4_recommendations
Return EasyApache 4 recommendations
GET
/ea4_save_profile
Create EasyApache 4 profile
GET
/eol_php_sites
Count domains using EOL PHP versions
Bandwidth and Disk Quotas 5
Accounts / Bandwidth and Disk Quotas
GET
/editquota
Update cPanel account disk quota
GET
/get_disk_usage
Return all cPanel accounts disk usage
GET
/limitbw
Update cPanel account bandwidth quota
GET
/quota_enabled
Validate cPanel account quotas
GET
/showbw
Return cPanel account bandwidth information
Security 3
The Security module for WHM API 1.
GET
/fetch_security_advice
Return Security Advisor results
GET
/getminimumpasswordstrengths
Return minimum password strength
GET
/setminimumpasswordstrengths
Update minimum password strength
Passwords 3
Accounts / Passwords
GET
/forcepasswordchange
Enable forced password update
GET
/get_password_strength
Return password strength
GET
/passwd
Update cPanel account password
Sitejet 4
The Sitejet module for WHM API.
GET
/get_commerce
Get Commerce Data
GET
/get_ecommercedeprecated
Get Ecommerce Data
GET
/set_commerce
Set Commerce URL
GET
/set_ecommercedeprecated
Set Ecommerce URL
Account Management 4
Accounts / Account Management
GET
/get_homedir_roots
Return home directories list
GET
/list_users
Return root and cPanel accounts
GET
/removeacct
Delete cPanel account
GET
/set_primary_domain_docroot
Change document root for cPanel account primary domain
InProductSurvey 1
In-product survey information.
GET
/get_in_product_survey_url
Get in-product survey URL
UserData 2
Scoped userdata storage functions.
GET
/get_scoped_userdata
Get scoped userdata
GET
/set_scoped_userdata
Set scoped userdata
Services 3
Server Administration / Services
GET
/get_service_proxy_backends
Return a cPanel account’s service proxying setup
GET
/set_service_proxy_backends
Update cPanel account service proxying
GET
/unset_all_service_proxy_backends
Remove cPanel account service proxying
Configurations 2
Server Administration / Configurations
GET
/get_tweaksetting
Return Tweak Settings option's value
GET
/set_tweaksetting
Update Tweak Settings option
Styles 1
Server Administration / Account Management
GET
/get_users_links
Return cPanel account theme's app keys and URLs
Web Log Retention 1
The Web Log Retention module for WHM API 1.
GET
/list_accounts_retention
List accounts' web log retention settings
Suspensions 4
Accounts / Suspensions
GET
/listlockedaccounts
Return suspended cPanel accounts
GET
/listsuspended
Return suspended cPanel accounts and information
GET
/suspendacct
Suspend cPanel account
GET
/unsuspendacct
Unsuspend cPanel account
ModSecurity 38
The ModSecurity module for WHM API 1.
GET
/modsec_add_rule
Add staged ModSecurity rule
GET
/modsec_add_vendor
Add ModSecurity vendor rules
GET
/modsec_assemble_config_text
Add ModSecurity configuration file text
GET
/modsec_batch_settings
Run ModSecurity batch settings
GET
/modsec_check_rule
Validate ModSecurity rule
GET
/modsec_clone_rule
Save ModSecurity rule copy
GET
/modsec_deploy_all_rule_changes
Enable all staged ModSecurity rule changes
GET
/modsec_deploy_rule_changes
Enable staged ModSecurity rule changes
GET
/modsec_deploy_settings_changes
Enable staged ModSecurity configuration files
GET
/modsec_disable_rule
Disable ModSecurity rule
GET
/modsec_disable_vendor
Disable ModSecurity vendor rules
GET
/modsec_disable_vendor_configs
Disable ModSecurity vendor configuration files
GET
/modsec_disable_vendor_updates
Disable ModSecurity vendor updates
GET
/modsec_discard_all_rule_changes
Remove all staged ModSecurity rule changes
GET
/modsec_discard_rule_changes
Remove staged ModSecurity rule changes
GET
/modsec_edit_rule
Update staged ModSecurity rule
GET
/modsec_enable_vendor
Enable ModSecurity vendor rules
GET
/modsec_enable_vendor_configs
Enable ModSecurity vendor configuration files
GET
/modsec_enable_vendor_updates
Enable ModSecurity vendor updates
GET
/modsec_get_config_text
Return ModSecurity configuration file
GET
/modsec_get_configs
Return all ModSecurity configuration files
GET
/modsec_get_configs_with_changes_pending
Return staged ModSecurity configuration files
GET
/modsec_get_log
Return ModSecurity logs
GET
/modsec_get_rules
Return ModSecurity rules
GET
/modsec_get_settings
Return ModSecurity configuration
GET
/modsec_get_vendors
Return ModSecurity vendors
GET
/modsec_is_installed
Return ModSecurity module status
GET
/modsec_make_config_active
Add ModSecurity configuration file include
GET
/modsec_make_config_inactive
Remove ModSecurity configuration file include
GET
/modsec_preview_vendor
Return ModSecurity vendor rule metadata
GET
/modsec_remove_rule
Remove ModSecurity rule
GET
/modsec_remove_setting
Remove ModSecurity configuration
GET
/modsec_remove_vendor
Remove ModSecurity vendor
GET
/modsec_report_rule
Export ModSecurity rule error report
GET
/modsec_set_config_text
Update ModSecurity configuration file
GET
/modsec_set_setting
Update ModSecurity configuration
GET
/modsec_undisable_rule
Enable ModSecurity rule
GET
/modsec_update_vendor
Update ModSecurity vendor ruleset
NGINX Manager 6
The NGINX Manager module for WHM API 1.
GET
/nginxmanager_clear_cache
Delete the user's NGINX cache.
GET
/nginxmanager_get_cache_config_system
Return NGINX caching configurations.
GET
/nginxmanager_get_cache_config_users
Return user NGINX caching configurations.
GET
/nginxmanager_rebuild_cache_config
Update NGINX configuration.
GET
/nginxmanager_reset_users_cache_config
Restore NGINX configuration to default values.
GET
/nginxmanager_set_cache_config
Update NGINX caching status.
cPanel Analytics 1
The cPanel Analytics module for WHM API 1.
GET
/participate_in_analytics
Enable analytics data gathering
PHP 14
The PHP module for WHM API 1.
GET
/php_get_handlers
Return PHP handlers
GET
/php_get_impacted_domains
Return PHP preconfigured domains
GET
/php_get_installed_versions
Return installed PHP versions
GET
/php_get_system_default_version
Return system default PHP version
GET
/php_get_vhost_versions
Return PHP version of all virtual hosts
GET
/php_get_vhosts_by_version
Return virtual hosts per PHP version
GET
/php_ini_get_content
Return PHP version's php.ini file
GET
/php_ini_get_directives
Return PHP version's directives
POST
/php_ini_set_content
Update PHP version's php.ini file
GET
/php_ini_set_directives
Update PHP version's directives
GET
/php_set_handler
Update PHP version's handler
GET
/php_set_session_save_path
Update PHP default save path
GET
/php_set_system_default_version
Update default PHP version
GET
/php_set_vhost_versions
Update domain's PHP values
Account Restoration 16
The Account Restoration module for WHM API 1.
GET
/restore_modules_summary
Return backup modules list
GET
/restore_queue_activate
Start restoration
GET
/restore_queue_add_task
Restore user account from backup
GET
/restore_queue_clear_all_completed_tasks
Remove all completed restoration tasks
GET
/restore_queue_clear_all_failed_tasks
Remove all failed restoration tasks
GET
/restore_queue_clear_all_pending_tasks
Remove all pending restoration tasks
GET
/restore_queue_clear_all_tasks
Remove all restoration tasks
GET
/restore_queue_clear_completed_task
Remove completed restoration task
GET
/restore_queue_clear_pending_task
Remove pending restoration task
GET
/restore_queue_is_active
Validate restoration queue is active
GET
/restore_queue_list_active
Return active restoration tasks list
GET
/restore_queue_list_completed
Return completed restoration tasks list
GET
/restore_queue_list_pending
Return pending restoration tasks list
GET
/restore_queue_state
Return restoration tasks list
GET
/restoreaccount
Restore account backup
GET
/verify_new_username_for_restore
Validate username during restoration
Support Tickets 14
The Support Tickets module for WHM API 1.
GET
/ticket_create_stub_ticket
Create initial Support ticket request
GET
/ticket_get_support_agreement
Import Technical Support Agreement text
GET
/ticket_get_support_info
Import customer information from Customer Portal
GET
/ticket_grant
Create Support SSH key
GET
/ticket_list
Return Support ticket status
GET
/ticket_remove_closed
Delete Support SSH key and closed tickets
GET
/ticket_revoke
Delete Support SSH key
GET
/ticket_ssh_test
Validate Customer Portal connection
GET
/ticket_ssh_test_start
Validate Support SSH connection
GET
/ticket_update_service_agreement_approval
Enable Technical Support Agreement acceptance
GET
/ticket_validate_oauth2_code
Validate Customer Portal OAuth2 code
GET
/ticket_whitelist_check
Validate Support IP addresses on firewall
GET
/ticket_whitelist_setup
Add Support IP addresses to firewall
GET
/ticket_whitelist_unsetup
Remove Support IP addresses from firewall
Schemas 155
The contract defines 155 schemas that model the data the API accepts and returns. The most detailed are Image (19 properties), MarketItem (17 properties), AppConfig (13 properties), Group (13 properties). Each schema is shown below with its type and property counts.
AmazonS3BackupDestinationResponse
AppConfig
object
13 properties
BackblazeBackupDestinationResponse
BackupDestinationGetResponse
BackupDestinationGetResponseAmazonS3
BackupDestinationGetResponseBackblaze
BackupDestinationGetResponseBase
object
5 properties
BackupDestinationGetResponseCustom
BackupDestinationGetResponseFTP
BackupDestinationGetResponseGoogleDrive
BackupDestinationGetResponseLocal
BackupDestinationGetResponseRsync
BackupDestinationGetResponseS3Compatible
BackupDestinationGetResponseSFTP
BackupDestinationGetResponseWebDAV
BackupDestinationResponse
object
5 properties
BackupDestinationResponseType
BackupDestinationSetParameterAmazonS3
BackupDestinationSetParameterBackblaze
BackupDestinationSetParameterBase
object
7 properties
1 required
BackupDestinationSetParameterCustom
BackupDestinationSetParameterFTP
BackupDestinationSetParameterGoogleDrive
BackupDestinationSetParameterLocal
BackupDestinationSetParameterRsync
BackupDestinationSetParameterS3Compatible
BackupDestinationSetParameterSFTP
BackupDestinationSetParameterType
BackupDestinationSetParameterWebDAV
CustomBackupDestinationResponse
DnsAddZoneParameterBase
object
5 properties
5 required
DnsAddZoneParameterType
DnsAddZoneParameterTypeA
DnsAddZoneParameterTypeA6
DnsAddZoneParameterTypeAAAA
DnsAddZoneParameterTypeAFSDB
DnsAddZoneParameterTypeALIAS
DnsAddZoneParameterTypeCAA
DnsAddZoneParameterTypeCNAME
DnsAddZoneParameterTypeDNAME
DnsAddZoneParameterTypeDS
DnsAddZoneParameterTypeHINFO
DnsAddZoneParameterTypeLOC
DnsAddZoneParameterTypeMX
DnsAddZoneParameterTypeNS
DnsAddZoneParameterTypePTR
DnsAddZoneParameterTypeRP
DnsAddZoneParameterTypeSOA
DnsAddZoneParameterTypeSRV
DnsAddZoneParameterTypeTXT
DnsEditZoneParameterBase
object
6 properties
3 required
DnsEditZoneParameterType
DnsEditZoneParameterTypeA
DnsEditZoneParameterTypeA6
DnsEditZoneParameterTypeAAAA
DnsEditZoneParameterTypeAFSDB
DnsEditZoneParameterTypeALIAS
DnsEditZoneParameterTypeCAA
DnsEditZoneParameterTypeCNAME
DnsEditZoneParameterTypeDNAME
DnsEditZoneParameterTypeDS
DnsEditZoneParameterTypeHINFO
DnsEditZoneParameterTypeLOC
DnsEditZoneParameterTypeMX
DnsEditZoneParameterTypeNS
DnsEditZoneParameterTypePTR
DnsEditZoneParameterTypeRP
DnsEditZoneParameterTypeSOA
DnsEditZoneParameterTypeSRV
DnsEditZoneParameterTypeTXT
FTPBackupDestinationResponse
GoogleDriveBackupDestinationResponse
Group
object
A group of features.
13 properties
7 required
Image
object
An individual WHM feature.
19 properties
8 required
Int0-999999NullOrUnlimited
Int0Max999999NullOrUnlimited
Int999999OrUnlimited
IntPosNullOrUnlimited
IntPosOrUnlimited
LocalBackupDestinationResponse
MarketItem
object
A product available from one of the cPanel Market providers.
17 properties
MarketItemType
MarketProviderMetaData
object
11 properties
Metadata
object
4 properties
Payload
array
The zone’s content.
Raw
object
Raw data for template directives.
2 properties
2 required
ResponseBase
object
2 properties
ResponseComment
ResponseControl
ResponseControlOrComment
ResponseRR
Role
The feature's server role. Warning: The server creates this parameter automatically. Do not edit this parameter's value. We do not support customizations to th…
RsyncBackupDestinationResponse
S3CompatibleBackupDestinationResponse
SFTPBackupDestinationResponse
SSLCertificateMarketItem
An SSL certificate product available from one of the cPanel Market providers.
SSLMarketProviderMetaData
Service
The [cPanel Service Daemon](https://go.cpanel.net/ThecPanelWHMServiceDaemons) that monitors the feature. Warning: The server creates this parameter automatical…
Subitem
object
A subsection of an individual WHM feature.
12 properties
8 required
TokenDetails
object
5 properties
Transfers_EnqueueTransferItem_Base
object
3 properties
2 required
Transfers_EnqueueTransferItem_Type
Transfers_EnqueueTransferItem_Type_AccountLocal_or_AccountRemoteRoot
Transfers_EnqueueTransferItem_Type_AccountRemoteRoot
Transfers_EnqueueTransferItem_Type_AccountRemoteUser
Transfers_EnqueueTransferItem_Type_Account_Base
Transfers_EnqueueTransferItem_Type_FeatureListRemoteRoot
Transfers_EnqueueTransferItem_Type_LegacyAccountBackup
Transfers_EnqueueTransferItem_Type_PackageRemoteRoot
WebDAVBackupDestinationResponse
a
An object representing A record data. Note: For more information about A records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
a6
An object representing A6 record data. Important: A6 records are deprecated. We strongly recommend that you use [AAAA](http://tools.ietf.org/html/rfc3596) reco…
aaaa
An object representing AAAA record data. Note: For more information about AAAA records, read [RFC 3596 at IANA](http://tools.ietf.org/html/rfc3596).
asfdb
An object representing AFSDB record data. Note: For more information about AFSDB records, read [RFC 1183 at IANA](http://tools.ietf.org/html/rfc1183).
bwSchema
caa
An object representing CAA record data. Note: For more information about CAA record flags and property tags, read the [RFC 6844](https://tools.ietf.org/html/rf…
cname
An object representing CNAME record data. Note: For more information about CNAME records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
diskSchema
dname
An object representing DNAME record data. Note: For more information about DNAME records, read [RFC 2672 at IANA](http://tools.ietf.org/html/rfc2672).
ds
An object representing DS record data. Note: For more information about DS records, read [RFC 4034 at IANA](http://tools.ietf.org/html/rfc4034).
getzonerecordResponseBase
object
5 properties
getzonerecordResponseTypeA
getzonerecordResponseTypeA6
getzonerecordResponseTypeAAAA
getzonerecordResponseTypeAFSDB
getzonerecordResponseTypeALIAS
getzonerecordResponseTypeCAA
getzonerecordResponseTypeCNAME
getzonerecordResponseTypeDNAME
getzonerecordResponseTypeDS
getzonerecordResponseTypeHINFO
getzonerecordResponseTypeLOC
getzonerecordResponseTypeMX
getzonerecordResponseTypeNS
getzonerecordResponseTypePTR
getzonerecordResponseTypeRP
getzonerecordResponseTypeSOA
getzonerecordResponseTypeSRV
getzonerecordResponseTypeSSHFP
getzonerecordResponseTypeTXT
hinfo
An object representing HINFO record data. Note: For more information about HINFO records, read [RFC 1700 at IANA](http://tools.ietf.org/html/rfc1700.txt).
ip-address
loc
An object representing LOC record data. Note: For more information about LOC records, read [RFC 1876 at IANA](http://tools.ietf.org/html/rfc1876).
mx
An object representing MX record data. Note: For more information about MX records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
nearReachedBaseSchema
object
3 properties
ns
An object representing NS record data. Note: For more information about NS records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
ptr
An object representing PTR record data. Note: For more information about PTR records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
record
object
4 properties
restorePoint
object
3 properties
rp
An object representing RP record data. Note: For more information about RP records, read [RFC 1183 at IANA](https://tools.ietf.org/html/rfc1183).
soa
An object representing SOA record data. Note: For more information about SOA records, read [RFC 1035 at IANA](http://tools.ietf.org/html/rfc1035).
srv
An object representing SRV record data. Note: For more information about SRV records, read [RFC 2782 at IANA](http://tools.ietf.org/html/rfc2782).
sshfp
An object representing SSHFP record data. Warning: We do not currently support this DNS record type. Note: For more information about SSHFP records, read [RFC…
txt
An object representing TXT record data. Note: For more information about TXT records, read [RFC 1464 at IANA](http://tools.ietf.org/html/rfc1464).
schemas-Transfers_EnqueueTransferItem_Type
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from cPanel 3
Other APIs cPanel publishes across the network.
cPanel UAPI
cPanel API 2 (Legacy)
Manage2 API
#Account#Packages#Reseller#Server Administration#WHM
Where this information came from
This is an independent, third-party profile of WHM API 1, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.