# Restore account backup

This function restores an account backup. You can use this function to restore daily,
weekly, or monthly backups.



* When you call this function, you  include at least one of
the , , , or  parameters.

* On servers with a custom  module, the function may not return XML
output. To properly return XML output, the  module  allow
the system to use the  module to capture output.



On servers that run CentOS 7, you may see a  warning about the absence of SPF
resource records on DNS.

* This warning is not relevant on CentOS 7 servers, because
RFC 7208 deprecated SPF records.
CentOS 7 servers use  records instead of  records.

* Red Hat 7.1 and CentOS 7.1 both contain , which is an updated
version of BIND that complies with RFC 7208. To resolve this issue, update your
operating system to a version that contains the updated version of BIND. For more
information, read the
Red Hat Bugzilla case about SPF record errors.

Endpoint: GET /restoreaccount
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `type` (string, required)
    The type of backup to restore. The function restores the most recent backup of
the type that you specify:

* 
* 
*
    Enum: "monthly", "weekly", "daily"

  - `user` (string, required)
    The account's username.
    Example: "username"

  - `all` (integer)
    Whether to create the account before restoration.

*  — Create and then restore the account. If you select this value and the
account already exists, the function will fail.
*  — Restore .
    Enum: 0, 1

  - `ip` (integer)
    Whether to assign a dedicated IP address to the restored account.

*  — Assign a dedicated IP address.
*  — Use the shared IP address.
    Enum: 0, 1

  - `mail` (integer)
    Whether to restore account-level filters (vfilters) and forwarders
(valiases).

*  — Restore.
*  — Do  restore.
    Enum: 0, 1

  - `mysql` (integer)
    Whether to restore the account's MySQL® databases.

*  — Restore.
*  — Do  restore.
    Enum: 0, 1

  - `subs` (integer)
    Whether to restore the account's subdomains.

*  — Restore.
*  — Do  restore.
    Enum: 0, 1

## Response 200 fields (application/json):

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "restoreaccount"

  - `metadata.output` (object)

  - `metadata.output.raw` (string)
    An output message that may contain long HTML.
    Example: "Extracting tarball...................\nDone<br />\nExtracting Domain....Done<br />\nDone<br />\n<br /><br />Restoring cpanel user config fileDone<br />\n<br />Restoring reseller privs (if any)<br />Restoring Locale Setting<br />Restoring SSL keys and CertificatesDone<br />\n<br />Restoring frontpage (if installed)Done<br />\n<br />Restoring access logs....\nDone<br />\n<br /><br />Restoring domain keys....\nDone<br />\n<br /><br />Restoring DB MAP File....\nDone<br />\n<br /><br /><span class=\"b2\">Restoring PostgreSQL databases....</span>\nRestoring PostgreSQL privs<!--\n-->\nDone<br />\n<br />Restoring Mailman listsDone<br />\n<br />Restoring Mailman ArchivesDone<br />\n<br />Restoring shell<blockquote><pre>Current shell /bin/bash is up to date.\n</pre></blockquote>Done<br />\n<br />Restoring password<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring proftpd fileDone<br />\n<br />Resyncing FTP Passwords<blockquote><pre>Updating ftp passwords for userFtp password files updated.Ftp vhost passwords synced</pre></blockquote>Done<br />\n<br />Linking old home directories<br />Parsing Domain Databases...ParkedDomains......AddonDomains...<br />Restoring Domains<br />\n<br />Restoring Bandwidth DataDone\n<br />Restoring Counter Data<pre></pre><br />Restoring Homedir....<blockquote><pre></pre></blockquote>Done<br />\n<br />Doing fileprotect conversion<br />Restoring nobody owned filesDone<br />\n<br />Restoring Mail filesDone<br />\n<br />Restoring userdata....\nDone<br />\n<br /><br />Restoring custom virtualhost templates....\nConverting email to cPanel 5+ (if needed)<blockquote><pre></pre></blockquote>Done<br />\n<br />Cleaning up filters (if needed)<blockquote><pre>vfilter converter v3.0Updating vfilter files to latest format.Running for user only (force=0) (has_spam_acl=1)Processing user......Done</pre></blockquote>Done<br />\n<br />Fixing mail permissions<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring crontabDone<br />\nConverting to maildir if needed<blockquote><pre></pre></blockquote>Done<br />\nRestoring Dns Zones<blockquote><pre>Restoring zone: user.com.db\n</pre></blockquote><br />Adding missing subdomain DNS entries (if needed)<pre></pre><br />Update Proxy subomains<blockquote><pre>Adding proxy subdomains for domain example.com.Records Installed</pre></blockquote>Done<br />\n<br />Updating SPF Records<blockquote><pre></pre></blockquote>Done<br />\n<br />Restoring quota<blockquote><pre></pre></blockquote>Done<br />\n<br /><br />Update mail routing<blockquote><pre>LOCAL MAIL EXCHANGER: This server will serve as a primary mail exchanger for example.com's mail.: This configuration has been manually selected.\n</pre></blockquote>Done<br />\n<br />Rebuilding Apache Conf<br />Restore CompleteAccount Restore Complete\nUnlocking password for user user.passwd: Success.<br />"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is . This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1