- 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
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Introduction
DNS functions allow you to manage your server's DNS zones and records.
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 - adddns — This function creates a DNS zone.
- WHM API 1 Functions - addzonerecord — This function adds a DNS zone record.
- WHM API 1 Functions - addzonerecord - Reverse DNS — This function uses PTR records to add reverse DNS functionality.
- WHM API 1 Functions - cluster_member_has_trust_with — This function queries whether nameservers in a DNS cluster can share records with one another.
- WHM API 1 Functions - create_parked_domain_for_user — This function creates an alias (parks a domain on a web virtual host).
- WHM API 1 Functions - dumpzone — This function returns a domain's DNS zone configuration.
- WHM API 1 Functions - editzonerecord — This function edits a DNS zone record.
- WHM API 1 Functions - get_nameserver_config — This function retrieves the default nameservers for the currently-authenticated user.
- WHM API 1 Functions - getzonerecord — This function returns a line from a domain's DNS zone configuration.
- WHM API 1 Functions - has_local_authority — This function checks whether the local server has the authority to publish changes for the domain's DNS records.
- WHM API 1 Functions - killdns — This function deletes a DNS zone.
- WHM API 1 Functions - listmxs — This function lists a domain's MX records.
- WHM API 1 Functions - listzones — This function lists the server's DNS zones.
- WHM API 1 Functions - lookupnsip — This function retrieves a nameserver's IP address.
- WHM API 1 Functions - lookupnsips — This function retrieves a nameserver's IPv4 and IPv6 addresses.
- WHM API 1 Functions - removezonerecord — This function deletes a DNS zone record.
- WHM API 1 Functions - resetzone — This function resets a DNS zone to its default values.
- WHM API 1 Functions - resolvedomainname — This function resolves a domain's IP address.
- WHM API 1 Functions - savemxs — This function creates a new MX record.
- WHM API 1 Functions - set_nameserver — This function sets the nameserver software that the remote servers in a DNS cluster run.
- WHM API 1 Functions - set_up_dns_resolver_workarounds — This function creates an Unbound http://www.linuxfromscratch.org/blfs/view/svn/server/unbound.html (libunbound) DNS resolver configuration.
- WHM API 1 Functions - setresolvers — This function configures the server's resolver nameservers.
- WHM API 1 Functions - update_nameservers_config — This function updates nameservers in the wwwacct.conf file.
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
root
user. - You must use the appropriate WHM ports (
2086
or2087
) 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.