Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - unsuspendreseller - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - unsuspendreseller
Skip to end of metadata
Go to start of metadata

Description


This function unsuspends a reseller account.

Warning:

This function also unsuspends all of the cPanel accounts that the reseller owns. 

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/unsuspendreseller?user=username
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/unsuspendreseller?user=username
 Command Line
whmapi1 unsuspendreseller user=username


Notes:

  • Unless otherwise noted, 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

 Output (JSON)
{
  "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"
  }
}
 Output (XML)
<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 =&gt; username@exampleowner.com via EMAIL [level =&gt; 3]
            </raw>
        </output>
        <result>1</result>
        <command>unsuspendreseller</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The reseller's username.

A valid reseller username on the server.username

Returns

This function only returns metadata.