- Created by Documentation, last modified on Apr 09, 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
Reseller functions allow you to manage your cPanel and WHM reseller accounts.
Available functions
- WHM API 1 Functions - acctcounts — This function lists a reseller's total accounts, suspended accounts, and account creation limit.
- WHM API 1 Functions - get_public_contact — This function retrieves an account's public contact information.
- WHM API 1 Functions - getresellerips — This function lists a reseller's available IP addresses.
- WHM API 1 Functions - listacls — This function lists the server's Access Control Lists (ACLs) and each list's privileges.
- WHM API 1 Functions - listresellers — This function lists the reseller accounts on the server.
- WHM API 1 Functions - resellerstats — This function lists data about a reseller's accounts.
- WHM API 1 Functions - saveacllist — This function creates or modifies an Access Control List (ACL).
- WHM API 1 Functions - set_public_contact — This function sets an account's public contact information.
- WHM API 1 Functions - setacls — This function creates or modifies an Access Control List (ACL).
- WHM API 1 Functions - setresellerips — This function adds IP addresses to a reseller's account.
- WHM API 1 Functions - setresellerlimits — This function sets a reseller's bandwidth and disk quotas.
- WHM API 1 Functions - setresellermainip — This function assigns a main IP address to a reseller's account.
- WHM API 1 Functions - setresellernameservers — This function assigns nameservers to a reseller's account.
- WHM API 1 Functions - setresellerpackagelimit — This function limits the packages that a reseller assigns to cPanel accounts.
- WHM API 1 Functions - setupreseller — This function grants reseller status to an account.
- WHM API 1 Functions - suspendreseller — This function suspends a reseller account.
- WHM API 1 Functions - terminatereseller — This function deletes a reseller and all of the reseller's cPanel accounts.
- WHM API 1 Functions - unsetupreseller — This function revokes reseller status from an account.
- WHM API 1 Functions - unsuspendreseller — This function unsuspends a reseller account.
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:Guide to WHM API 1 — WHM API 1 accesses the WHM interface's features.
-
Page:WHM API 1 - Filter Output — You can use additional variables to filter WHM API 1 output.
-
Page:WHM API 1 - Sort Output — You can use additional variables to sort WHM API 1 output.
-
Page:WHM API 1 - Paginate Output — You can use additional variables to paginate WHM API 1 output.
-
Page:WHM API 1 - Return Data — WHM API 1 outputs data in either JSON or XML format.