cPanel API 2 Functions - Park::park - Knowledgebase

Description

This function parks a domain on another 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=park&domain=example.com&topdomain=subdomain

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
   
// Park a domain.
$park = $cpanel->api2(
    'Park', 'park',
       array(
       'domain'     => 'example.com'
       'topdomain'  => 'subdomain'
    )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
   
# Park a domain.
my $park = $cpliveapi->api2(
    'Park', 'park',
    {
        'domain'           => 'example.com'
        'subdomain'        => 'subdomain'
    }
);

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": "park",
    "data": [
      {
        "reason": "example.com was successfully parked on top of subdomain.example.com",
        "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

Parameter	Type	Description	Possible values	Example
domain	string	Required The domain name to park.	A valid domain name.	example.com
topdomain	string	The domain on which to park the domainparameter's domain. If you do not specify a topdomain value, the function parks the domain domain on the cPanel account's main domain.	An existing subdomain name on the cPanel account. For example, subdomain if the subdomain is subdomain.example.com	subdomain

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain name to park.

A valid domain name.

example.com

topdomain

string

The domain on which to park the domainparameter's domain.

If you do not specify a topdomain value, the function parks the domain domain on the cPanel account's main domain.

An existing subdomain name on the cPanel account. For example, subdomain if the subdomain is subdomain.example.com

subdomain

Returns

Return	Type	Description	Possible values	Example
reason	string	A message of success or a reason for failure.	A string that describes the success or error.	This is an error message.
result	boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories