Suspensions
Suspend cPanel account
This function suspends an account.
get/suspendacct
Query parameters
userstring required
Example:username
The account to suspend.
disallowun0 | 1
Example:1
Whether to allow only the root user to unsuspend the account.
- 1 - Only the root user can unsuspend the account.
- 0 - The root user or the account's owner can unsuspend the account.
leave-ftp-accts-enabled0 | 1
Whether to skip suspension of the account's FTP accounts.
- 1 - Do not suspend the FTP accounts.
- 0 - Suspend the FTP accounts.
reasonstring
Example:Nonpayment
The reason for suspension.
Important:
We strongly recommend that you provide a reason for suspension whenever you suspend an account.
Response
HTTP Request was successful.
Example response
{
"metadata": {
"command": "suspendacct",
"output": {
"raw": "Changing Shell to /bin/false...Changing shell for username. Warning: \"/bin/false\" is not listed in /etc/shells. Shell changed. Done Locking Password...Locking password for user username. passwd: Success Done Suspending mysql users Using Universal Quota Support (quota=0) Suspending websites... Using Universal Quota Support (quota=0) Suspending FTP accounts... Updating FTP passwords for username FTP password files updated. FTP vhost passwords synced username's account has been suspended\n"
},
"reason": "OK",
"result": 1,
"version": 1
}
}