Child pages
  • cPanel API 1 Functions - Park::unpark
Skip to end of metadata
Go to start of metadata

Description

This function unparks a parked domain (alias).

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.
$unpark_domain = $cpanel->api1('Park','unpark',array('example.com','0') ); // 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 $unpark_domain = $cpliveapi->api1('Park','unpark',['example.com','0'] ); # 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::unpark( $FORM('domain','isaddon') )">
 Command Line
cpapi1 --user=username Park unpark example.com 0


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)
examplepark.com => deleted from example.
example.com was successfully unparked

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The domain name.

A valid domain name.example.com
isaddonBoolean

Whether to use the addon domain removal routines.

This parameter defaults to 0.

  • 1 — Use the addon domain removal routines.
  • 0 — Use the standard removal routines.
0

Returns

This function returns a confirmation message.