cPanel API 1 Functions - Park::park - Knowledgebase

Description

This function parks domains, or adds addon domains. This function also allows you to:

Park a domain onto an addon domain.
Add an addon domain with the same document root as another addon domain.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — Park::park— This function parks a domain on another domain.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$park_domain = $cpanel->api1('Park','park', array('example.com') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $park_domain = $cpliveapi->api1('Park','park', ['example.com'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Park::park( $FORM('domain') )">

Output (plaintext)

Using nameservers with the following IPs: 192.168.1.10, 192.168.1.11
parkeddomain.com was successfully parked on top of example.com

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The name of the domain to park.	A valid domain name.	example.com
topdomain	string	The base subdomain on which to park an addon domain. By default, the main account's document root contains the parked domain's document root.	A valid domain name.	example.targetdomain.com
disallowdot	boolean	Whether to strip dots (.) from the topdomainparameter.	1 — Strip the dots. 0 — Leave the dots.	1

Returns

This function returns a confirmation message that displays the parked domain and the domain on which the system parked it.

Knowledgebase

Categories

Categories