cPanel API 2 Functions - SubDomain::listsubdomains

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists the cPanel account's subdomains.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

DomainInfo::list_domains — This function lists the cPanel account's domains.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SubDomain&cpanel_jsonapi_func=listsubdomains&regex=domain&return_https_redirect_status=1

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List the subdomains that are associated with a cPanel account.
$listsubdomains = $cpanel->api2(
    'SubDomain', 'listsubdomains',
 array(
        'regex' => 'domain',
        'return_https_redirect_status' => '1',
  )
);

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.

# Lists subdomains that are associated with a cPanel account.
my $listsubdomains = $cpliveapi->api2(
    'SubDomain', 'listsubdomains',
{
        'regex' => 'domain',
        'return_https_redirect_status' => '1',
  }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username SubDomain listsubdomains regex=domain return_https_redirect_status=1

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "listsubdomains",
        "data": [{
            "domainkey": "subdomain_example.com",
            "rootdomain": "example.com",
            "status": "not redirected",
            "is_https_redirecting": "0",
            "can_https_redirect": "0",
            "all_aliases_valid": "0",
            "subdomain": "subdomain",
            "reldir": "home:public_html/subdomain",
            "basedir": "public_html\/subdomain",
            "dir": "/home/example/public_html/subdomain",
            "domain": "subdomain.example.com",
            "web_subdomain_aliases": "1"
        }],
        "event": {
            "result": 1
        },
        "module": "SubDomain"
    }
}

Note:

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

Parameters

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`regex`	string	A Perl Compatible Regular Expression (PCRE) that filters the results. If you do not use this parameter, the function returns all of a cPanel account's subdomains.	A valid PCRE.	`domain`
`return_https_redirect_status`	Boolean	Whether to return the secure redirect status of the addon domains. We added this parameter in cPanel & WHM version 80. This parameter defaults to `0`.	`1` — Return status. `0` — Do not return status.	`1`

regex

string

A Perl Compatible Regular Expression (PCRE) that filters the results.

If you do not use this parameter, the function returns all of a cPanel account's subdomains.

A valid PCRE.

domain

return_https_redirect_status

Boolean

Whether to return the secure redirect status of the addon domains.

We added this parameter in cPanel & WHM version 80.

This parameter defaults to 0.

1 — Return status.
0 — Do not return status.

1

Returns

Return	Type	Description	Possible values	Example
`domainkey`	string	The subdomain's domain key.	The subdomain, an underscore, and the main domain.	`subdomain_example.com`
`rootdomain`	string	The cPanel account's main domain.	A valid domain on the account.	`example.com`
`status`	string	Whether the subdomain redirects to another domain.	A valid string.	`not redirected`
`is_https_redirecting`	Boolean	Whether the domain redirects to `https`. This return only appears if you set the `return_https_redirects_status` parameter to `1`. We added this return in cPanel & WHM version 80.	`1` — Redirects. `0` — Does not redirect.	`0`
`can_https_redirect`	Boolean	Whether a valid SSL certificate or AutoSSL runs on the domain. This return only appears if you set the `return_https_redirects_status` parameter to `1`. We added this return in cPanel & WHM version 80.	`1` — A valid SSL certificate exists or AutoSSL runs. `0` — A valid SSL certificate does not exist, and AutoSSL does not run.	`0`
`all_aliases_valid`	Boolean	Whether a valid SSL certificate exists on the domain's aliases. This return only appears if you set the `return_https_redirects_status` parameter to `1`. We added this return in cPanel & WHM version 80.	`1` — A valid SSL certificate exists on the aliases. `0` — A valid SSL certificate does not exist on the aliases.	`0`
`subdomain`	string	The subdomain name.	A valid string.	`subdomain`
`reldir`	string	The path to the domain's document root, relative to the cPanel account's home directory.	A valid directory path, relative to the user's home directory, with a `home:` prefix.	`home:public_html/subdomain`
`basedir`	string	The directory that contains the subdomain's document root.	A valid directory path, relative to the user's home directory.	`public_html/subdomain`
`dir`	string	The absolute path to the subdomain's document root.	The absolute path to the subdomain's document root.	`/home/example/public_html/subdomain`
`domain`	string	The subdomain and main domain names.	A valid domain on the account.	`subdomain.domain.com`
`reason`	string	A reason for failure. This function only returns a `reason` value if there was an error.	A string that describes the error.	`This is an error message.`
`web_subdomain_aliases`	array	The type of subdomain alias. We added this return in cPanel & WHM version 60.	`0` — `mail` subdomain `1` — `www` subdomain	`1`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`