# Restore email forwarders

This function restores an account's email forwarders.



When the Receive Mail role is disabled, the system also  this function.



You  use the  parameter when you call this function in one of the following formats:
* As part of a  request body to upload and restore a backup file to the server. For more information about this structure, read Mozilla's POST Method documentation.
* As a query parameter to restore an existing file on the server.

Endpoint: POST /Backup/restore_email_forwarders
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `backup` (string)
    The email forwarder file to restore.



 pass this parameter to restore email forwarder files that already exist on the server.



To restore multiple email filter files, increment the parameter name. For example: , , and .

  - `timeout` (integer)
    The maximum number of seconds to try to restore the file.
*  - The system will not time out the file restoration.
    Example: 3600

  - `verbose` (integer)
    Whether to return additional information from the  log files.
*  - Return additional information.
*  - Do not return additional information.
    Enum: 0, 1

## Request fields (multipart/form-data):

  - `backup` (string)

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "restore_email_forwarders"

  - `module` (string)
    The name of the module called.
    Example: "Backup"

  - `result` (object)

  - `result.data` (object)

  - `result.data.log_id` (string)
    The log file's restoration identification (ID). The system uses the backup restoration's date to create this ID. The ID is in [ISO-8601 Date Time](https://en.wikipedia.org/wiki/ISO_8601) format with the log's revision number appended.
    Example: "2019-08-13T15:10:07Z.1"

  - `result.data.log_path` (string)
    The filepath to the backup restoration's log file.
    Example: "/home/cpuser/.cpanel/logs/restore-email-forwarders/2019-09-11T18:30:49Z.1.log"

  - `result.data.messages` (array)
    An array of statements about the database's restoration.
    Example: ["The system successfully restored the email forwarders from the 'aliases-example.com.gz' backup."]

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

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

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.