Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

Remove Exim Dry Run Configuration Files — remove_in_progress_exim_config_edit

When cPanel & WHM attempts to update your Exim configuration, dry run files are created in place of your ordinary configuration files. If the update fails, these dry run files are left in place. This means that when you access Exim's advanced configuration editor, you will be accessing these dry run files instead of the actual configuration files.

This function allows you to remove dry run files after a failed Exim update attempt.

Calling Functions

Using the XML API

To use the XML API to perform the remove_in_progress_exim_config_edit function from within your custom script:

  • Append the /xml-api/remove_in_progress_exim_config_edit function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/remove_in_progress_exim_config_edit

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the remove_in_progress_exim_config_edit function from within your custom script:

  • Append the /json-api/remove_in_progress_exim_config_edit function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/remove_in_progress_exim_config_edit

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

None

Output

  • remove_in_progress_exim_config_edit — The function's results container.
    • status (boolean) — A boolean value that indicates success or failure. A value of 1 indicates success.
    • statusmsg (string) — A message of success or reason for failure.

Examples

XML API

Calling the URL https://example.com/xml-api/remove_in_progress_exim_config_edit in WebHost Manager will produce output similar to:

<remove_in_progress_exim_config_edit>
	<status>1</status>
	<statusmsg>Removed OK</statusmsg>
</remove_in_progress_exim_config_edit>

JSON API

Calling the URL https://example.com/json-api/remove_in_progress_exim_config_edit in WebHost Manager will produce output similar to:

{
   "status":1,
   "statusmsg":"Removed OK"
}

Topic revision: r1 - 14 Feb 2012 - 21:53:41 - Main.JustinSchaefer