UAPI Functions - ModSecurity::list_domains - Knowledgebase

Description

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

Examples

cPanel or Webmail Session URL

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

LiveAPI PHP Class

$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'

);

LiveAPI Perl Module

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',

);

 cPanel Template Toolkit

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

Command Line

uapi --user=username ModSecurity list_domains

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
    "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
        }
    ]
}

Note:

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

Parameters

This function does not accept parameters.

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 comma-separated list of domain-related search terms.	A comma-separated list of string values.
enabled	Boolean	Whether ModSecurity is enabled for the account.	1 — Enabled. 0 — Disabled.	1

Knowledgebase

Categories

Categories