cPanel API 2 Functions - Park::unpark

Warning:

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

Description

This function removes a parked domain (alias) or an addon 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=fenway.com&subdomain=fenway.example.com

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.

// Remove a parked domain.
$unpark = $cpanel->api2(
    'Park', 'unpark',
       array(
       'domain'     => 'fenway.com'
       'subdomain'  => 'fenway.example.com'
    )
);

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.

# Remove a parked domain.
my $unpark = $cpliveapi->api2(
    'Park', 'unpark',
    {
        'domain'           => 'fenway.com'
        'subdomain'        => 'fenway.example.com'
    }
);

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 unpark domain=fenway.com subdomain=fenway.example.com

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": "unpark",
    "data": [
      {
        "reason": "fenway.com was successfully unparked",
        "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

Return Type Description Possible values Example

Return	Type	Description	Possible values	Example
`domain`	string	Required The parked domain.	A valid domain on the cPanel account.	`fenway.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 subdomain on the cPanel account.	`fenway.example.com`

domain

string

Required

The parked domain.

A valid domain on the cPanel account.

fenway.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 subdomain on the cPanel account.

fenway.example.com

Returns

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