Child pages
  • WHM API 1 Functions - remove_in_progress_exim_config_edit
Skip to end of metadata
Go to start of metadata

Description

This function removes in-progress Exim configuration files after a failed update to Exim. When cPanel & WHM attempts to update an Exim configuration, the system creates dry run files to replace of the ordinary configuration files.

  • If the update fails, the system leaves these dry run files in place. 
  • When the user accesses the Advanced Editor section of WHM's Exim Configuration Manager interface (Home >> Service Configuration >> Exim Configuration Manager), they access these dry run files instead of the actual configuration files.

Important:

In cPanel & WHM version 76 and later, when you disable the MailSend role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remove_in_progress_exim_config_edit?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remove_in_progress_exim_config_edit?api.version=1
 Command Line
whmapi1 remove_in_progress_exim_config_edit


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "Removed OK",
    "command": "remove_in_progress_exim_config_edit",
    "result": 1
  }
}
 Output (XML)
<result>
    <metadata>
        <command>remove_in_progress_exim_config_edit</command>
        <version>1</version>
        <result>1</result>
        <reason>Removed OK</reason>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

This function only returns metadata.