Description
This function lists the cPanel account's addon domains.
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
{
"cpanelresult": {
"apiversion": 2,
"func": "listaddondomains",
"data": [
{
"domainkey": "boomer_example.com",
"rootdomain": "example.com",
"status": "not redirected",
"subdomain": "boomer",
"reldir": "home:public_html/boomer.com",
"dir": "/home/example/public_html/boomer.com",
"basedir": "public_html/boomer.com",
"domain": "boomer.com",
"fullsubdomain": "boomer.example.com"
},
{
"domainkey": "sooner_example.com",
"rootdomain": "example.com",
"status": "not redirected",
"subdomain": "sooner",
"reldir": "home:public_html/sooner.com",
"dir": "/home/example/public_html/sooner.com",
"basedir": "public_html/sooner.com",
"domain": "sooner.com",
"fullsubdomain": "sooner.example.com"
}
],
"event": {
"result": 1
},
"module": "Park"
}
}
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 enter a value for this parameter, the function returns all addon domains that reside on the server. |
A valid PCRE. |
domain |
Returns
Return
|
Type
|
Description
|
Possible values
|
Example
|
domainkey
|
string
|
The addon domain's domain key.
|
The cPanel account's username, an underscore (_), and the main domain name.
|
username_maindomain.com
|
domain
|
string
|
The addon domain's name.
|
A valid domain on the account.
|
addon-example.com
|
rootdomain
|
string
|
The cPanel account's main domain.
|
A valid domain on the account.
|
example.com
|
status
|
string
|
Whether the addon domain redirects to another domain.
|
|
not redirected
|
fullsubdomain
|
string
|
The subdomain that corresponds to the addon domain.
|
A valid string.
|
username
|
reldir
|
string
|
The path to the domain's document root.
|
The relative path to the addon domain's document root.
The function prefaces this value with home:
|
home:public_html/addon-example.com/
|
dir
|
string
|
The absolute path to the addon domain's document root.
|
The absolute path to the addon domain's document root.
|
/home/user/public_html/addon-example.com
|
basedir
|
string
|
The directory that contains the addon domain's document root.
|
The path to the addon domain's document root, relative to the cPanel account's home directory.
The function prefaces this value with home:
|
public_html/addon-example.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
|