- Created by Documentation, last modified on Oct 05, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
Introduction
Addon Domain functions allow you to manage addon domains or convert them to full cPanel accounts.
Important:
In cPanel & WHM version 76, we introduced server profiles and roles. When you enable a non-Standard Node server profile, the system disables API calls associated with that profile's disabled roles.
Available functions
- WHM API 1 Functions - convert_addon_fetch_conversion_details — This function returns the details of the convert addon domain to account process.
- WHM API 1 Functions - convert_addon_fetch_domain_details — This function retrieves domain data for an addon domain.
- WHM API 1 Functions - convert_addon_get_conversion_status — This function returns the status of the convert addon domain to account process for specified conversion jobs.
- WHM API 1 Functions - convert_addon_initiate_conversion — This function initiates the conversion process for an addon domain into a cPanel account.
- WHM API 1 Functions - convert_addon_list_addon_domains — This function returns a list of addon domains that belong to the current user.
- WHM API 1 Functions - convert_addon_list_conversions — This function returns a list of addon domains converted into cPanel accounts.
WHM API 1 Basics
Available in:
WHM 11+
Languages:
JSON, XML
Methods:
GET, POST
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that you authenticate as the
rootuser. - You must use the appropriate WHM ports (
2086or2087) to call WHM API functions.
Related Documentation
-
Page:WHM API 1 Functions - list_configclusterservers — This function lists the servers in the server's configuration cluster.
-
Page:WHM API 1 Functions - update_configclusterserver — This function updates the username or remote access key for a cluster server.
-
Page:WHM API 1 Functions - delete_configclusterserver — This function removes a server from a configuration cluster.
-
Page:WHM API 1 Functions - add_configclusterserver — This function adds a server to a configuration cluster.
-
Page:WHM API 1 Functions - abort_transfer_session — This function aborts an active transfer session.