cPanel API 2 Functions - SubDomain::listsubdomains - Knowledgebase

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

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

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username SubDomain listsubdomains regex=domain

Notes:

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

 Output (JSON)

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

Note:

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

Parameters

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

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

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
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. Note: This function only returns a reason value if there was an error.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories