Account Restoration
Restore Account
Restore user account from backup
This function restores a user's cPanel account from a backup file.
get/restore_queue_add_task
Query parameters
restore_pointstring required
Example:2019-10-21T00:00:00.000Z
The date of the backup to use, in YYYY-MM-DD format.
userstring required
Example:username
The cPanel account's username.
destidstring
Example:LmTZCUpqqLSPH8AO7pVtIeNK
The destination's identification string.
- local — The local directory.
- The destination ID string's value.
give_ip0 | 1
Example:1
Whether to assign the account a dedicated IP address.
- 1 — Assign a dedicated IP address.
- 0 — Use the shared IP address.
mail_config0 | 1
Example:1
Whether to restore the account's email configuration.
- 1 — Restore.
- 0 — Do not restore.
mysql0 | 1
Example:1
Whether to restore the account's MySQL® databases.
- 1 — Restore.
- 0 — Do not restore.
subdomains0 | 1
Example:1
Whether to restore the account's subdomains.
- 1 — Restore.
- 0 — Do not restore.
Response
HTTP Request was successful.
Example response
{
"data": {
"queue_id": "3b99QG5fp99tdL5"
},
"metadata": {
"command": "restore_queue_add_task",
"reason": "OK",
"result": 1,
"version": 1
}
}