Child pages
  • WHM API 0 Functions - unsetupreseller
Skip to end of metadata
Go to start of metadata

 

Description

This function revokes reseller status from an account.

Examples 


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


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "result":[
      {
         "status":1,
         "statusmsg":"Finished unsuspending reseller."
      }
   ],
   "output":"Changing shell for username.\nShell changed.\nUnlocking password for user
username.\npasswd: Success.\nUnsuspending FTP accounts...\nUpdating ftp passwords for
username\nFtp password files updated.\nFtp vhost passwords synced\nusername's account is
now active\nUnsuspending mysql users\nNotification => admin@example.com via EMAIL
[level => 3]\n"
}
 Output (XML)
<unsuspendreseller>
     <output>
        Changing shell for username.
        Shell changed.
        Unlocking password for user username.
        passwd: Success.
        Unsuspending FTP accounts...
        Updating ftp passwords for username
        Ftp password files updated.
        Ftp vhost passwords synced
        username's account is now active
        Unsuspending mysql users
        Notification => admin@example.com via EMAIL [level => 3]
      </output>
      <result>
            <status>1</status>
            <statusmsg>Finished unsuspending reseller.</statusmsg>
      </result>
</unsuspendreseller>

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account's username.

A valid reseller username on the server.username

Returns

ReturnTypeDescriptionPossible valuesExample

result

array of hashes

An array of hashes of function output.

This hash includes the status and statusmsg returns.

 

status

Boolean

Whether the function succeeded.

The function returns this value in the result hash.

  • 1 — Success.
  • 0 — Failure.
1

statusmsg

string

A message of success or a reason for failure.

The function returns this value in the  result hash.

  • null
  • An error message.

null

outputstringOutput from the function's action.

One or more valid strings.

Note:

This output may contain HTML. 

 Click to view...
Changing shell for username.\nShell changed.\nUnlocking password for user
username.\npasswd: Success.\nUnsuspending FTP accounts...\nUpdating ftp passwords for
username\nFtp password files updated.\nFtp vhost passwords synced\nusername's account is
now active\nUnsuspending mysql users\nNotification => admin@example.com via EMAIL
[level => 3]\n