cPanel API 2 Functions - Park::listparkeddomains

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 parked domains (aliases).

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=Park&cpanel_jsonapi_func=listparkeddomains&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.

// Lists parked domains.
$listparkeddomains = $cpanel->api2(
    'Park', 'listparkeddomains'
    array(
        '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 parked domains.
my $listparkeddomains = $cpliveapi->api2(
    'Park', 'listparkeddomains',
    array(
        '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 Park listparkeddomains 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": "listparkeddomains",
        "data": [{
                "domain": "comiskey.com",
                "status": "not redirected",
                "is_https_redirecting": "0",
                "can_https_redirect": "0",
                "all_aliases_valid": "0",
                "reldir": "home:public_html",
                "dir": "/home/example/public_html",
                "basedir": "public_html",
                "web_subdomain_aliases": "1"
            },
            {
                "domain": "wrigley.com",
                "status": "not redirected",
                "is_https_redirecting": "0",
                "can_https_redirect": "0",
                "all_aliases_valid": "0",
                "reldir": "home:public_html",
                "dir": "/home/example/public_html",
                "basedir": "public_html",
                "web_subdomain_aliases": "0"
            }
        ],
        "event": {
            "result": 1
        },
        "module": "Park"
    }
}

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 enter a value for this parameter, the function returns all parked domains that reside on the server.	A valid PCRE.	`domain`
`return_https_redirect_status`	Boolean	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`

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 parked domains that reside on the server.

A valid PCRE.

domain

return_https_redirect_status

Boolean

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

Return	Type	Description	Possible values	Example
`domain`	string	The parked domain's name.	A valid domain on the account.	`comiskey.com`
`status`	string	Whether the parked domain redirects to another domain. Note: If multiple redirects exist for a domain, this function reports the first one in that appears in the `.htaccess` file.	`not redirected` — The parked domain does not redirect to another domain. The URL to which the domain redirects.	`not redirected`
`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 exists 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_valid`	Boolean	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 78.	`1` — A valid SSL certificate exists on the aliases. `0` — A valid SSL certificate does not exist on the aliases.	`0`
`reldir`	string	The path to the parked 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:`	`home:public_html`
`dir`	string	The absolute path to the parked domain's document root.	The absolute path to the parked domain's document root.	`/home/example/public_html`
`basedir`	string	The directory that contains the parked domain's document root.	The directory path to the parked domain's document root.	`public_html`
`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`
`web_subdomain_aliases`	array	The type of subdomain alias. Note: We added this return in cPanel & WHM version 60.	`0` — `mail` subdomain `1` — `www` subdomain	`1`