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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

 

Description

This function sets the contents of a specified ModSecurity™ configuration file. The system will stage any changes to the configuration file. To deploy the changes, call WHM API 1's modsec_deploy_rule_changes function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/modsec_set_config_text?api.version=1&config=modsec2.example.conf&text=SecRule%2520REQUEST_URI%2520"example"%2520"deny%252Cid%253A123456789"%250ASecAction%2520"pass%252Cauditlog%252Cid%253
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_set_config_text?api.version=1&config=modsec2.example.conf&text=SecRule%2520REQUEST_URI%2520"example"%2520"deny%252Cid%253A123456789"%250ASecAction%2520"pass%252Cauditlog%252Cid%253
 Command Line
whmapi1 modsec_set_config_text config=modsec2.example.conf text=SecRule%20REQUEST_URI%20\"example\"%20\"deny%2Cid%3A123456789\"%0ASecAction%20\"pass%2Cauditlog%2Cid%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_set_config_text"
    }
}
 Output (XML)
<result>
   <data />
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>modsec_set_config_text</command>
   </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
configstring

Required

The configuration file name.

A valid filename.
modsec2.example.conf
textstring

Required

The configuration text.

A valid string.

 

 Click to view...
SecRule REQUEST_URI "example" "deny,id:123456789" SecAction "pass,auditlog,id"

Returns

This function only returns metadata.

  • No labels