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

Description

This function enables ModSecurity™ for specified domains.

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/enable_domains?domains=example.com%2Cdallas.example.com%2Cgalveston.example.com


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.
 
// Enable ModSecurity for specified domains. 
$enable_modsec = $cpanel->uapi(
    'ModSecurity', 'enable_domains',
	array(
		'domains'			=> 'example.com, dallas.example.com, galveston.example.com'
	)
);


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.
 
# Enable ModSecurity for specified domains. 
my $enable_modsec = $cpliveapi->uapi(
    'ModSecurity', 'enable_domains',
		{
		'domains' 			=> 'example.com, dallas.example.com, galveston.example.com'
        }
);


Note:

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

 

 cPanel Template Toolkit
<!-- Get a hash of all the data, then display the enabled values. -->
[% data = execute( 'ModSecurity', 'enable_domains' ); %]
[% FOREACH q = data.enabled %]
     <p>
         [% q %]
     </p>
[% END %]
   
<!-- Get only the enabled value. -->
[% execute('ModSecurity', 'enable_domains' ).data.enabled %]


Note:

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

 

 Command Line
uapi --user=username ModSecurity enable_domains domains=example.com%2Cdallas.example.com%2Cgalveston.example.com


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": {
        "transformed": 1
    },
    "data": [
        {
            "domain": "example.com",
            "dependencies": [
                "arkansas.com",
                "kansas.com",
                "nevada.com",
                "newmexico.com",
                "texas.com"
            ],
            "type": "main",
            "searchhint": "arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com",
            "enabled": 0
        },
        {
            "domain": "dallas.example.com",
            "dependencies": [
                "dallas.com"
            ],
            "type": "sub",
            "searchhint": "dallas.com",
            "enabled": 0
        },
        {
            "domain": "galveston.example.com",
            "dependencies": [
                "galveston.com"
            ],
            "type": "sub",
            "searchhint": "galveston.com",
            "enabled": 0
        }
    ]
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The domains for which to enable ModSecurity.

A comma-separated list of valid domains that the cPanel account owns.

Important:

The authenticated cPanel account must own these domains.

example.com,dallas.example.com,galveston.example.com

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe domain.A valid domain on the cPanel account.example.com
dependenciesarray

An array of domains that your changes to a selected domain affect.

An array of valid domains on the cPanel account.
"arkansas.com",
"kansas.com",
"nevada.com",
"newmexico.com",
"texas.com"
typestringThe domain type.
  • main — A main domain.
  • sub — A subdomain.
main
searchhintstring

A list of domain-related search terms.

A comma-separated list of string values.
 Click to view...
arkansas.com,kansas.com,nevada.com,newmexico.com,texas.com
enabledBoolean

Whether ModSecurity is enabled on the domain.

  • 1 — Enabled.

  • 0 — Disabled.

1