Child pages
  • WHM API 1 Functions - unsuspendacct
Skip to end of metadata
Go to start of metadata

 

Description

This function unsuspends an account.

Note:

Only the root account and root-enabled resellers can unsuspend a locked account.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/unsuspendacct?api.version=1&user=username
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/unsuspendacct?api.version=1&user=username
 Command Line
whmapi1 unsuspendacct 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

 Output (JSON)
{  
   "metadata":{  
      "version":1,
      "reason":"OK",
      "output":{  
         "raw":"<script>if (window.clear_ui_status) clear_ui_status();<\/script>\n 
Changing shell for username.\n 
Shell changed.\n 
Unlocking password for user username.\n 
passwd: Success\n 
Unsuspending FTP accounts...\n 
Updating ftp passwords for rosie\n 
Ftp password files updated.\n 
Ftp vhost passwords synced\n 
username's account is now active\n Unsuspending mysql users\n Notification => username@example.com via EMAIL [level => 3]\n"
      },
      "result":1,
      "command":"unsuspendacct"
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <output>
            <raw>
                <script>if (window.clear_ui_status) clear_ui_status();</script>
                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 =&gt; username@example.com via EMAIL [level =&gt; 3]
            </raw>
        </output>
        <result>1</result>
        <command>unsuspendacct</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 account to unsuspend.

A valid cPanel or WHM username on the server.username

 

Returns

This function only returns metadata.