cPanel API 2 Functions - Park::unpark - Knowledgebase

Description

This function removes a parked 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=unpark&domain=jack.com&subdomain=hill.com

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Remove a parked domain.
$unpark = $cpanel->api2(
    'Park', 'unpark',
       array(
       'domain'     => 'jack.com'
       'subdomain'  => 'hill.com'
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# List the /home directory backups.
my $unpark = $cpliveapi->api2(
    'Park', 'unpark',
    {
        'domain'           => 'jack.com'
        'subdomain'        => 'hill.com'
    }
);

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "unpark",
    "data": [
      {
        "reason": "jack.com was successfully unparked",
        "result": 1
      }
    ],
    "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
domain	string	Required The parked domain.	A valid domain on the cPanel account.	jack.com
subdomain	string	The addon domain or subdomain's parent domain. Note: Use this parameter if the domain addon domain or subdomain is parked on another addon domain or subdomain.	A valid domain on the cPanel account.	hill.com

Return

Type

Description

Possible values

Example

domain

string

Required

The parked domain.

A valid domain on the cPanel account.

jack.com

subdomain

string

The addon domain or subdomain's parent domain.

Note:

Use this parameter if the domain addon domain or subdomain is parked on another addon domain or subdomain.

A valid domain on the cPanel account.

hill.com

Returns

Return	Type	Description	Possible values	Example
reason	string	Whether the function succeeded or failed.	A string that describes the error or success.	jack.com was successfully unparked
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories