Description

This function returns ModSecurity's™ status for a cPanel account's domains.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/ModSecurity/list_domains



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List ModSecurity's status for all domains.
$modsec_domains_status = $cpanel->uapi(
    'ModSecurity', 'list_domains'
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List ModSecurity's status for all domains.
my $modsec_domains_status = $cpliveapi->uapi(
    'ModSecurity', 'list_domains',
);

 



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



uapi --user=username ModSecurity list_domains



{
    "messages": null,
    "errors": null,
    "status": 1,
    "metadata": {
        "modsec": {
            "total_disabled": 3,
            "total_enabled": 3
        },
        "transformed": 1
    },
    "data": [
        {
            "domain": "dallas.example.com",
            "dependencies": [
                "dallas.com"
            ],
            "type": "sub",
            "searchhint": "dallas.com",
            "enabled": 1
        },
        {
            "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": 1
        },
        {
            "domain": "galveston.example.com",
            "dependencies": [
                "galveston.com"
            ],
            "type": "sub",
            "searchhint": "galveston.com",
            "enabled": 1
        },
        {
            "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
        }
    ]
}



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 comma-separated list of domain-related search terms.

A comma-separated list of string values.


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


enabledBoolean

Whether ModSecurity is enabled for the account.

  • 1 — Enabled.

  • 0 — Disabled.

1