Return ModSecurity vendors

The function returns a list of configured ModSecurity™ vendors.

Important:

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

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  modsec_get_vendors

Response samples

Content type
application/json
{
  • "data": {
    • "vendors": [
      • {
        • "configs": [
          • {
            • "active": 1,
            • "config": "modsec_vendor_configs/SAMPLE/modsecurity_crs_10_setup.conf",
            • "vendor_id": "SAMPLE"
            },
          • {
            • "active": 0,
            • "config": "modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_16_session_hijacking.conf",
            • "vendor_id": "SAMPLE"
            },
          • {
            • "active": 1,
            • "config": "modsec_vendor_configs/SAMPLE/optional_rules/modsecurity_crs_46_av_scanning.conf",
            • "vendor_id": "SAMPLE"
            }
          ],
        • "cpanel_provided": 0,
        • "description": "A SAMPLE-curated ModSecurity rule set.",
        • "dist_md5": "ffbaa3a7ead8dfaf0b661a729ce6ad3b",
        • "dist_sha512": "b55c09bb1835ed4209f0f3ea4a70d099665363f23d3819c0369be429438d675ba2c749dcefdb85cee682ee0bf485558e67d0b0965fe4799865529d943e8e14cb",
        • "enabled": 1,
        • "in_use": 32,
        • "inst_dist": "SAMPLE_1415038544",
        • "installed": 1,
        • "name": "SAMPLE ModSecurity Core Rule Set",
        • "path": "/usr/local/apache/conf/modsec_vendor_configs/SAMPLE",
        • "supported_versions": [
          • "2.9.1",
          • "2.9.2",
          • "2.9.3"
          ],
        • "update": 1,
        • "vendor_id": "SAMPLE",
        }
      ]
    },
  • "metadata": {
    • "command": "modsec_get_vendors",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}