Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function reverts a currently-in-progress Exim configuration edit.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/remove_in_progress_exim_config_edit
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/remove_in_progress_exim_config_edit
 Command Line
whmapi0 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 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
 {
   "status":1,
   "statusmsg":"Removed OK"
}
 Output (XML)
 <remove_in_progress_exim_config_edit>
    <status>1</status>
    <statusmsg>Removed OK</statusmsg>
</remove_in_progress_exim_config_edit>

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
remove_in_progress_exim_config_editstringA hash of function results.This hash includes the status and statusmsg returns. 

status

Boolean

Whether the function failed.

The function returns this value in the remove_in_progress_exim_config_edit hash.

  • 1 — Success.
  • 0 — Failure.
 1

statusmsg

string

A message of success or reason for failure.

The function returns this value in the remove_in_progress_exim_config_edit hash.

A valid string.Removed OK