cPanel WHM icon

cPanel WHM

Full cPanel WHM API — all 622 operations across Accounts, DNS, Mail, SSL, Backups, Databases and more

Actions262

Account → Unsuspend cPanel account

AI-generated

Summary

Unsuspend a specified cPanel account by its username, optionally retaining service proxies during the unsuspension process.

Inputs

  • User (required) — The username of the cPanel account to unsuspend.
  • Retain-Service-Proxies — Optionally retain service proxies on the account. Set to '1' to retain service proxies or '0' to not retain them. Defaults to '0'.

Output shape

a single JSON object reflecting the WHM API response to the unsuspend request

The output contains the result status and any messages returned by the WHM API indicating success or failure of the unsuspend operation. Errors will be thrown by the node if the API response indicates failure.

Examples

Example 1: Unsuspend account without retaining service proxies

Set 'User' to the target account username and leave 'Retain-Service-Proxies' at default '0'. The node calls WHM's 'unsuspendacct' API endpoint to unsuspend the account.

Example 2: Unsuspend account retaining service proxies

Set 'User' to the target account username and set 'Retain-Service-Proxies' to '1' to keep existing service proxies active during unsuspension.

Links

Discussion