cPanel API 2 Functions - Park::listparkeddomains - Knowledgebase

Description

This function lists the cPanel account's parked 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

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Lists parked domains.

$listparkeddomains = $cpanel->api2(

'Park', 'listparkeddomains'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List parked domains.

my $listparkeddomains = $cpliveapi->api2(

'Park', 'listparkeddomains',

);

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 our Deprecated 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 Park listparkeddomains

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listparkeddomains",
    "data": [
      {
        "domain": "jack.com",
        "status": "not redirected",
        "reldir": "home:public_html",
        "dir": "/home/example/public_html",
        "basedir": "public_html"
      },
      {
        "domain": "jill.com",
        "status": "not redirected",
        "reldir": "home:public_html",
        "dir": "/home/example/public_html",
        "basedir": "public_html"
      }
    ],
    "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 parked domains that reside on the server.	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 enter a value for this parameter, the function returns all parked domains that reside on the server.

A valid PCRE.

domain

Returns

Return	Type	Description	Possible values	Example
domain	string	The parked domain's name.	A valid domain on the account.	jack.com
status	string	Whether the parked domain redirects to another domain.	not redirected — The parked domain does not redirect to another domain. redirected — The parked domain redirects to another domain.	not redirected
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

Knowledgebase

Categories

Categories