WHM API 1 Functions - modsec_undisable_rule

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_undisable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/modsec_undisable_rule?api.version=1&config=modsec_vendor_configs%2Fexample.conf&id=1234567890

Command Line

whmapi1 modsec_undisable_rule config=modsec_vendor_configs%2Fexample.conf id=1234567890

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_undisable_rule"
    }
}

Output (XML)

<result>
  <data></data>
  <metadata>
    <command>modsec_undisable_rule</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

Parameter Type Description Possible values Example

config

string

Required

The ModSecurity configuration file.

The path to a ModSecurity configuration file, relative to the /usr/local/apache/conf/ directory.

Note:

Do not set this value to the modsec2.conf file. The function will not run correctly for this file.

modsec_vendor_configs/example.conf

id

string

Required

The ModSecurity rule's ID.

A valid ModSecurity rule.

1234567890

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 11.46+

Methods:

GET, POST

Required Parameters:

config,id

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Sections - ModSecurity — ModSecurity functions allow you to manage ModSecurity rules and vendors on your server.
Page:

WHM API 1 Functions - modsec_add_rule — This function adds a new rule to a ModSecurity™ configuration staging file.
Page:

WHM API 1 Functions - modsec_assemble_config_text — This function adds text to a ModSecurity™ configuration file.
Page:

WHM API 1 Functions - modsec_clone_rule — This function copies a ModSecurity™ rule with a new rule ID.
Page:

WHM API 1 Functions - modsec_deploy_all_rule_changes — This function deploys the staged changes for all of the ModSecurity™ configuration files into the live configuration files.

Child pages