Run ModSecurity batch settings

This function adds, updates, and removes global ModSecurity™ configuration directives. The function modifies these directives in the /usr/local/apache/conf/modsec2.cpanel.conf file.

Important:

When you disable the Web Server role, the system disables this function.

This function only supports the following ModSecurity™ configuration directives:

setting_id	Documentation
0	SecAuditEngine
1	SecConnEngine
2	SecRuleEngine
3	SecDisableBackendCompression
4	SecGeoLookupDb
5	SecGsbLookupDb
6	SecGuardianLog
7	SecHttpBlKey
8	SecPcreMatchLimit
9	SecPcreMatchLimitRecursion

SecurityBasicAuth

Request

query Parameters

setting_id required	integer [ 0 .. 9 ] The configuration setting's ID. Note: To configure multiple IDs, increment the parameter name. For example, `setting_id1`, `setting_id2`, and `setting_id3`. Examples: Set or update multiple configuration settings, in this case: SecConnEngine, SecRuleEngine, and SecDisableBackendCompression. setting_id=setting_id1=1 setting_id2=2 setting_id3=3 Set or update a single configuration setting, in this case for SecConnEngine. setting_id=1
required	string or string or string or string or integer The configuration setting's current state. `On` `Off` Some settings accept additional values for this parameter. See the references above for more inforamation. Note: To configure multiple settings, increment the parameter name. For example, `state1`, `state2`, and `state3`. `state` is ignored if `remove` is set to `1` for the setting. Examples: Set the state of multiple configuration settings. state=state1=On state2=On state3=Off Set the state of a single configuration setting. state=On
remove	integer Default: 0 Whether to add or remove the configuration setting in the `/usr/local/apache/conf/modsec2.cpanel.conf` file. `1` — Remove the configuration setting. `0` — Add or update the configuration setting. To remove multiple settings, increment the parameter name. For example, `remove1`, `remove2`, and `remove3`. Enum: 1 0 Examples: Remove some settings when updating or setting multiple configuration settings. This example removes the second setting indicated in `setting_id2` and updates the other two settings. remove=remove1=0 remove2=1 remove3=0 Remove a single configuration setting requested in the `setting_id` remove=1

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/modsec_batch_settings

Request samples

whmapi1 --output=jsonpretty \
  modsec_batch_settings \
  setting_id='1' \
  state='On'

Response samples

application/json

{"data": {"updated_settings": [{"default": 1500,
"description": "define the match limit of the PCRE library.",
"directive": "SecAuditEngine",
"engine": 1,
"name": "Audit Log Level",
"radio_options": [{"name": "Log all transactions.",
"option": "On"
}
],
"setting_id": 1,
"state": "On",
"type": "radio",
"url": "https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit"
}
]
},
"metadata": {"command": "modsec_batch_settings",
"reason": "OK",
"result": 1,
"version": 1
}
}