AddonDomain
List the addon domains
This function lists the cPanel account's addon domains: the domains that are parked on a subdomain of the account's primary domain, rather than on the primary domain itself.
Note:
Use the Park::listparkeddomains function for the domains parked on the primary domain.
get/AddonDomain/listaddondomains
Query parameters
regexstring
Example:addon[.]com$
A Perl regular expression. The system returns only the addon domains whose name matches this pattern, case-insensitively.
return_https_redirect_status0 | 1
Example:1
Whether to include the can_https_redirect and is_https_redirecting fields in each entry.
- 1 - Include the HTTPS redirect status.
- 0 - Omit the HTTPS redirect status.
Response
HTTP Request was successful.
Example response
{
"data": [
{
"basedir": "public_html/addon",
"can_https_redirect": 1,
"dir": "/home/username/public_html/addon",
"domain": "addon.com",
"domainkey": "addon_example.com",
"fullsubdomain": "addon.example.com",
"reldir": "home:public_html/addon",
"rootdomain": "example.com",
"subdomain": "addon"
}
],
"status": 1
}