- Created by Documentation, last modified on Sep 19, 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
Description
This function unsuspends a reseller account.
Warning:
This function also unsuspends all of the cPanel accounts that the reseller owns.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/unsuspendreseller?user=username
https://hostname.example.com:2087/cpsess##########/xml-api/unsuspendreseller?user=username
whmapi1 unsuspendreseller user=username
Notes:
- You must URI-encode values.
- For more information and additional output options, read our Guide to WHM API 1 documentation or run the
whmapi1 --help
command. If you run CloudLinux™, you must use the full path of the
whmapi1
command:/usr/local/cpanel/bin/whmapi1
{ "metadata": { "version": 1, "reason": "OK", "output": { "raw": "Changing shell for example.\n Shell changed.\n Unlocking password for user example.\n passwd: Success\nFound /etc/proftpd/example with contents. It will be archived as '/etc/proftpd/example.unsuspend_failed' and replaced with the previously suspended version.\n Unsuspending FTP accounts...\n Updating ftp passwords for example\n Ftp password files updated.\n Ftp vhost passwords synced\n example's account is now active\n Unsuspending mysql users\n Notification => username@exampleowner.com via EMAIL [level => 3]\n" }, "result": 1, "command": "unsuspendreseller" } }
<result> <metadata> <version>1</version> <reason>OK</reason> <output> <raw> Changing shell for example. Shell changed. Unlocking password for user example. passwd: Success Found /etc/proftpd/example with contents. It will be archived as '/etc/proftpd/example.unsuspend_failed' and replaced with the previously suspended version. Unsuspending FTP accounts... Updating ftp passwords for example Ftp password files updated. Ftp vhost passwords synced example's account is now active Unsuspending mysql users Notification => username@exampleowner.com via EMAIL [level => 3] </raw> </output> <result>1</result> <command>unsuspendreseller</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
user | string | Required The reseller's username. | A valid reseller username on the server. | username |
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11+
Methods:
GET, POST
Required Parameters:
user
Return Formats:
About WHM API 1
WHM API 1 performs functions and accesses data in WHM.
Notes:
- Some functions and parameters may require that the caller authenticate as the
root
user. - You must use the appropriate WHM ports (
2086
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - acctcounts — This function lists a reseller's total accounts, suspended accounts, and account creation limit.
-
Page:WHM API 1 Functions - getresellerips — This function lists a reseller's available IP addresses.
-
Page:WHM API 1 Functions - listresellers — This function lists the reseller accounts on the server.
-
Page:WHM API 1 Functions - setresellerips — This function adds IP addresses to a reseller's account.
-
Page:WHM API 0 Functions - setresellermainip — This function assigns a main IP address to a reseller's account.