Child pages
  • WHM API 1 Functions - unsuspendreseller

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description


Excerpt

This function unsuspends a reseller account.


Warning
titleWarning:

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


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/unsuspendreseller?user=username



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/unsuspendreseller?user=username



Expand
titleCommand Line


Code Block
languagebash
whmapi1 unsuspendreseller user=username

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "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"
  }
}



Expand
titleOutput (XML)


Code Block
languagexml
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The reseller's username.

A valid reseller username on the server.username

Returns

This function only returns metadata.