Child pages
  • cPanel API 2 Functions - AddonDomain::listaddondomains
Skip to end of metadata
Go to start of metadata

Description

This function lists an account's addon domains.

Warning:

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

Examples


 WHM API (JSON)
https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=AddonDomain&cpanel_jsonapi_func=listaddondomains&regex=username_example.com&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 account's addon domains.
$list_addons = $cpanel->api2(
    'AddonDomain', 'listaddondomains', 
    array(
        'regex'           => 'rutabaga',
		'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.
 
# List the account's addon domains.
my $list_addons = $cpliveapi->api2(
    'AddonDomain', 'listaddondomains',
    { 
        'regex'           => 'rutabaga',
		'return_https_redirect_status' => '1',
    }
);


Note:

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

 cPanel Tag System (deprecated)


Warnings:

  • 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. 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 AddonDomain listaddondomains regex=rutabega return_https_redirect_status=1


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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": "listaddondomains",
    "data": [
      {
        "domain": "addondomain.com",
        "dir": "http://www.example.com/addondomain/home/dir",
        "reldir": "home:addondomain/home/dir",
        "basedir": "addondomain/home/dir",
        "status": "1",
		"is_https_redirecting" : "0",
		"can_https_redirect" : "0",
		"all_aliases_valid" : "0",
        "domainkey": "username_example.com",
        "subdomain": "username",
        "rootdomain": "example.com",
        "fullsubdomain": "username.example.com"
        "web_subdomain_aliases": "1"
      }
      {
        "domain": "secondaddon.com",
        "dir": "http://www.example.com/seconduser/dir/path",
        "reldir": "home:seconduser/dir/path",
        "basedir": "seconduser/dir/path",
        "status": "1",
		"is_https_redirecting" : "0",
		"can_https_redirect" : "0",
		"all_aliases_valid" : "0",
        "domainkey": "seconduser_example.com",
        "subdomain": "seconduser",
        "rootdomain": "example.com",
        "fullsubdomain": "seconduser.example.com"
		"web_subdomain_aliases": "1"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "AddonDomain"
  }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
regexstring

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

If you do not enter a value for this parameter, the function returns all addon domains that exist on the server.

A valid PCRE.

rutabaga
return_https_redirect_statusBoolean

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

Note:

We added this parameter in cPanel & WHM version 80.

This parameter defaults to 0.

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

Returns

ReturnTypeDescriptionPossible valuesExample
domainstringThe addon domain's name.A valid domain name.addondomain.com
dirstringThe absolute path to the addon domain's document root.A valid absolute file path.

http://www.example.com/addondomain/home/dir

reldirstringThe path to the addon domain's document root, relative to the cPanel account's home directory.A valid file path.home:addondomain/home/dir
basedirstringThe relative path to the addon domain's document root.A valid relative file path.addondomain/home/dir 
statusBooleanWhether the addon domain is redirected.
  • 1 — The addon domain is redirected.
  • 0 — The addon domain is not redirected.
1
is_https_redirecting
Boolean

Whether the domain redirects to https.

Important:

This return only appears if you set the return_https_redirects_status parameter to 1.

Note:

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.

Important:

This return only appears if you set the return_https_redirects_status parameter to 1.

Note:

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_validBoolean

Whether a valid SSL certificate exists on the domain's aliases.

Important:

This return only appears if you set the return_https_redirects_status parameter to 1.

Note:

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
domainkeystringThe addon domain's username and main domain.A username, the underscore character (_), and the account's main domain.username_example.com
subdomainstring

The addon domain's username.

Note:

This return's value is also the addon domain's FTP username. 

A valid username.username
rootdomainstringThe main domain.A valid domain name.example.com
fullsubdomainstringThe addon domain's username and subdomain.A username, a dot (.), and the account's main domain.username.example.com
reasonstring

A reason for failure.

Note:

This function only returns a reason value if an error occurrs. 

A string that describes the error.This is an error message.
web_subdomain_aliasesBoolean

The type of subdomain alias.

Note:

We added this return in cPanel & WHM version 60.

  • 1www subdomain
  • 0mail subdomain
1
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1