Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the ModSecurity™ configuration files that have staged changes.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/modsec_get_configs_with_changes_pending?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/modsec_get_configs_with_changes_pending?api.version=1
 Command Line
whmapi1 modsec_get_configs_with_changes_pending

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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
    "data": {
        "configs": [
            "modsec2.user.conf",
            "modsec_vendor_configs/vendor_test.conf"
        ]
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_get_configs_with_changes_pending"
    }
}
 Output (XML)
<result>
   <data>
      <configs>modsec2.user.conf</configs>
      <configs>modsec_vendor_configs/vendor_test.conf</configs>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>modsec_get_configs_with_changes_pending</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

ReturnTypeDescriptionPossible valuesExample
configsarrayAn array of ModSecurity configuration files.An array of one or more ModSecurity configuration file names.
modsec2.user.conf