Developer Documentation
Child pages
  • WHM API 1 Functions - modsec_get_configs_with_changes_pending
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

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

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_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:

  • 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": {
        "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

Function information

API Version:

WHM API 1

Available in:

WHM 11.46+

Methods:

GET, POST

Required Parameters:

(none)

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

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.