# cPanel API 2 Functions - Park::park

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function creates an alias (parks a domain on another domain).

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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&disallowdot=0
```

Note:
For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Park a domain.
$park = $cpanel->api2(
    'Park', 'park',
       array(
       'domain'      => 'example.com',
       'topdomain'   => 'subdomain',
       'disallowdot' => '0',
    )
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Park a domain.
my $park = $cpliveapi->api2(
    'Park', 'park',
    {
        'domain'       => 'example.com',
        'topdomain'    => 'subdomain',
        'disallowdot'  => '0',
    }
);
```

Note:
For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Park park domain=example.com topdomain=subdomain disallowdot=0
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the
`cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
domain
td
em
string
td
p
strong
Required
p
The domain name to park.
td
p
A valid domain name.
td
code
example.com
tr
td
code
topdomain
td
em
string
td
p
The subdomain on which to park the 
code
domain
 parameter's domain.
p
If you specify a 
code
topdomain
 value, the function creates an addon domain under the subdomain that you specify.
p
If you do not specify a 
code
topdomain
 value, the function parks the 
code
domain
 domain on the cPanel account's main domain.
td
ul
li
A subdomain on the cPanel account.
li
A subdomain name on the cPanel account. For example, 
code
subdomain
 if the subdomain is 
code
subdomain.example.com
td
code
subdomain
tr
td
code
disallowdot
td
em
Boolean
td
p
Whether to strip the dots from the top
code
domain
p
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Strip all dots.
li
code
0
 — Append the 
code
topdomain
 parameter's value to the main domain.
td
code
0
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
reason
td
em
string
td
p
A message of success or a reason for failure.
td
p
A string that describes the success or error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1