This function performs a full restoration of a single cPanel account from a cpmove
tarball.
cpmovepath required | string A filepath that contains the account's Note: You can use the pkgacct script to create a Example: cpmovepath=/home/cpmove-newacct.tar.gz |
dedicated_ip | integer Default: 0 Whether to assign the account a dedicated IP address.
The system must have an available IP address. Example: dedicated_ip=0 |
delete_archive | integer Default: 0 Whether to delete the
Example: delete_archive=0 |
string or string Default: ".existing" The server on which the account's email will reside after the system completes the transfer.
| |
overwrite | integer Default: 0 Whether to overwrite an existing account on the server, if one exists.
Example: overwrite=1 |
restricted | integer Default: 0 Whether to perform a restricted restore for the account. The system will perform security checks on the backup file. If you do not trust the source of the account backup with
Important:
Example: restricted=0 |
update_a_records | string Default: "all" Whether to perform one of the following actions to the account's A records:
Example: update_a_records=all |
username | string <username> The username to give to the restored cPanel account. This will default to the username provided in the backup files. Example: username=example |
HTTP Request was successful.
object | |
object |
whmapi1 --output=jsonpretty \ start_local_cpmove_restore \ cpmovepath='/home/cpmove-newacct.tar.gz'
{- "data": {
- "transfer_session_id": "example202003301756425ugO"
}, - "metadata": {
- "command": "start_local_cpmove_restore",
- "reason": "OK",
- "result": 1,
- "version": 1
}
}