Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - modsec_deploy_settings_changes - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - modsec_deploy_settings_changes
Skip to end of metadata
Go to start of metadata

Description

This function deploys the staged changes to your modsec2.cpanel.conf file and attempts to restart Apache. If the new settings fail validation, the system restores the modsec2.cpanel.conf file.

Note:

Call the WHM API 1 modsec_set_setting function to prepare your changes for the modsec2.cpanel.conf file.

Important:

  • On systems that run EasyApache 3, the changes save to the /usr/local/apache/conf/modsec2.cpanel.conf file.  
  • On systems that run EasyApache 4 and cPanel & WHM version 56 or earlier, the changes save to the /etc/apache2/conf.d/modsec2.cpanel.conf file.
  • On systems that run EasyApache 4 and cPanel & WHM version 58 or later, the changes save to the /etc/apache2/conf.d/modsec/modsec2.cpanel.conf file.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer 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/modsec_deploy_settings_changes?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_deploy_settings_changes?api.version=1
 Command Line
whmapi1 modsec_deploy_settings_changes


Notes:

  • Unless otherwise noted, 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)
 {
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_deploy_settings_changes"
    }
}
 Output (XML)
 <result>
  <data/>
  <metadata>
    <version>1</version>
    <reason>OK</reason>
    <result>1</result>
    <command>modsec_deploy_settings_changes</command>
  </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.