Child pages
  • UAPI Functions - ModSecurity::enable_all_domains

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function enables ModSecurity™ on a cPanel account's domains.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titlecPanel or Webmail Session URL


Code Block
languagetext
https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/enable_all_domains

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Enable ModSecurity for all domains.
$enable_all_modsec = $cpanel->uapi(
    'ModSecurity', 'enable_all_domains'
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Enable ModSecurity's for all domains.
my $enable_all_modsec = $cpliveapi->uapi(
    'ModSecurity', 'enable_all_domains',
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Template Toolkit


Code Block
languagexml
linenumberstrue
<!-- Get a hash of all the data, then display the enabled values. -->
[% data = execute( 'ModSecurity', 'enable_all_domains' ); %]
[% FOREACH q = data.enabled %]
     <p>
         [% q %]
     </p>
[% END %]
   
<!-- Get only the enabled value. -->
[% execute('ModSecurity', 'enable_all_domains' ).data.enabled %]

Include Page
LIB:_TTLink
LIB:_TTLink


Expand
titleCommand Line


Code Block
languagebash
uapi --user=username ModSecurity enable_all_domains 

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {
        "transformed": 1
    },
    "data": [
        {
            "domain": "dallas.example.com",
            "dependencies": [
                "dallas.com"
            ],
            "type": "sub",
            "searchhint": "dallas.com",
            "enabled": 0
        },
        {
            "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": "galveston.example.com",
            "dependencies": [
                "galveston.com"
            ],
            "type": "sub",
            "searchhint": "galveston.com",
            "enabled": 0
        },
        {
            "domain": "houston.example.com",
            "dependencies": [
                "houston.com"
            ],
            "type": "sub",
            "searchhint": "houston.com",
            "enabled": 0
        },
        {
            "domain": "neworleans.example.com",
            "dependencies": [
                "neworleans.com"
            ],
            "type": "sub",
            "searchhint": "neworleans.com",
            "enabled": 0
        },
        {
            "domain": "sanantonio.example.com",
            "dependencies": [
                "sanantonio.com"
            ],
            "type": "sub",
            "searchhint": "sanantonio.com",
            "enabled": 0
        }
    ]
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe domain.A valid domain on the cPanel account.example.com
dependenciesarrayAn 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.


Expand
titleClick to view...

arkansas.com,kansas.com, nevada.com,newmexico.com,texas.com 


enabledBoolean

Whether ModSecurity is enabled on the account.

  • 1 — Enabled.

  • 0 — Disabled.

0