cPanel API 2 Functions - Park::park

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function creates an alias (parks a domain on another domain).

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=park&domain=example.com&topdomain=subdomain&disallowdot=0

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.

// Park a domain.
$park = $cpanel->api2(
    'Park', 'park',
       array(
       'domain'      => 'example.com',
       'topdomain'   => 'subdomain',
       'disallowdot' => '0',
    )
);

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.

# Park a domain.
my $park = $cpliveapi->api2(
    'Park', 'park',
    {
        'domain'       => 'example.com',
        'topdomain'    => 'subdomain',
        'disallowdot'  => '0',
    }
);

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 park domain=example.com topdomain=subdomain disallowdot=0

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": "park",
    "data": [
      {
        "reason": "example.com was successfully parked on top of subdomain.example.com",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Park"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The domain name to park.	A valid domain name.	`example.com`
`topdomain`	string	The subdomain on which to park the `domain` parameter's domain. If you specify a `topdomain` value, the function creates an addon domain under the subdomain that you specify. If you do not specify a `topdomain` value, the function parks the `domain` domain on the cPanel account's main domain.	A subdomain on the cPanel account. A subdomain name on the cPanel account. For example, `subdomain` if the subdomain is `subdomain.example.com`	`subdomain`
`disallowdot`	Boolean	Whether to strip the dots from the top`domain` This parameter defaults to `0`.	`1` — Strip all dots. `0` — Append the `topdomain` parameter's value to the main domain.	`0`

domain

string

Required

The domain name to park.

A valid domain name.

example.com

topdomain

string

The subdomain on which to park the domain parameter's domain.

If you specify a topdomain value, the function creates an addon domain under the subdomain that you specify.

If you do not specify a topdomain value, the function parks the domain domain on the cPanel account's main domain.

A subdomain on the cPanel account.
A subdomain name on the cPanel account. For example, subdomain if the subdomain is subdomain.example.com

subdomain

disallowdot

Boolean

Whether to strip the dots from the topdomain

This parameter defaults to 0.

1 — Strip all dots.
0 — Append the topdomain parameter's value to the main domain.

0

Returns

Return	Type	Description	Possible values	Example
`reason`	string	A message of success or a reason for failure.	A string that describes the success or error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`