latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Configuration Clusters

Update configuration file from backup

This function restores a configuration backup from a file. If the backup file does not contain any changes, the system does not write to the configuration file.

get/restore_config_from_file

Query parameters

modulestring required
Example:Main

The configuration module's name.

Important:

This parameter is case-sensitive. You must enter the parameter in the correct case format; otherwise, the function will fail.

pathstring required
Example:/var/cpanel/cpanel.config

The absolute path to configuration file.

Note: If this parameter contains JSON or equals-sign key and value pairs, they must appear in new lines.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "restore_config_from_file",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}