Child pages
  • UAPI Functions - ModSecurity::has_modsecurity_installed
Skip to end of metadata
Go to start of metadata

Description

This function checks whether ModSecurity™ is installed on a server.

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 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/has_modsecurity_installed


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Return ModSecurity's installation status.
$modsec_installation_status = $cpanel->uapi(
    'ModSecurity', 'has_modsecurity_installed'
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List ModSecurity's installation status.
my $modsec_installation_status = $cpliveapi->uapi(
    'ModSecurity', 'has_modsecurity_installed',
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Template Toolkit
<!-- Get modsecurity's installation status. -->
[% execute('ModSecurity', 'has_modsecurity_installed' ) %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username ModSecurity has_modsecurity_installed


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
 {
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {},
    "data": {
        "installed": 1
    }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
installedBoolean

Whether ModSecurity is installed on the server.

  • 1 — Installed.

  • 0 — Not installed.

1