Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
cPanel API 1 Functions - Park::park - Developer Documentation - cPanel Documentation
Child pages
  • cPanel API 1 Functions - Park::park
Skip to end of metadata
Go to start of metadata

Description

This function parks domains (aliases), 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:

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.


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.
my $park_domain = $cpliveapi->api1('Park','park', ['example.com'] ); # Call the function.


Note:

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

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Park::park( $FORM('domain') )">
 Command Line
cpapi1 --user=username Park park example.com


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 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

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The name of the domain to park.

A valid domain name.example.com


topdomainstring

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
disallowdotBoolean

Whether to strip dots (.) from the topdomain parameter.

This parameter defaults to 0.

  • 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.