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

Description

This function removes a global ModSecurity™ configuration directive.

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_remove_setting?api.version=1&setting_id=3
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_remove_setting?api.version=1&setting_id=3
 Command Line
whmapi1 modsec_remove_setting setting_id=3


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)
{
    "data": {},
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_remove_setting"
    }
}
 Output (XML)
<result>
  <data></data>
  <metadata>
    <command>modsec_remove_setting</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
setting_idinteger

Required

The setting's ID.

A valid setting ID.

For a list of available settings and their IDs, call the WHM API 1 modsec_get_settings function.

                 3 
              

Returns

This function only returns metadata.