UAPI Functions - ModSecurity::enable_domains - Knowledgebase

Description

This function enables ModSecurity™ for specified domains.

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

 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'
    )
);

 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'
        }
);

 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 %]

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.

Output (JSON)

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
domains	string	Required The domains for which to enable ModSecurity.	A comma-separated list of valid domains that the cPanel account owns. Important: The authenticated cPanel accountmust own these domains.	example.com,dallas.example.com,galveston.example.com

Parameter

Type

Description

Possible values

Example

domains

string

Required

The domains for which to enable ModSecurity.

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

Important:

The authenticated cPanel accountmust own these domains.

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

Returns

Return	Type	Description	Possible values	Example
domain	string	The domain.	A valid domain on the cPanel account.	example.com
dependencies	array	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"
type	string	The domain type.	main — A main domain. sub — A subdomain.	main
searchhint	string	A list of domain-related search terms.	A comma-separated list of string values.
enabled	Boolean	Whether ModSecurity is enabled on the domain.	1 — Enabled. 0 — Disabled.	1

Knowledgebase

Categories

Categories