Park an alias domain on an existing domain
This function parks (aliases) a domain on the cPanel account, so that the domain serves the content of a domain that already exists on the account.
Important:
- Without the topdomain parameter, the system parks the domain on the account's primary domain.
- With the topdomain parameter, the system parks the domain on a subdomain of the primary domain. That arrangement is how an addon domain is represented. To create an addon domain and its subdomain in one call, use the AddonDomain::addaddondomain function instead.
- The account must have either the Parked Domains or the Addon Domains feature. Parking on the primary domain requires the Parked Domains feature specifically.
When you disable the Web Server role, the system disables this function.
Request
- Base URLhttps://cpanel-server.tld:2083/execute
- AuthHTTP basic
Query parameters
The domain to park. The system removes a leading www. from this value and converts it to lowercase before it validates the domain.
Whether to remove the dot (.) characters from the topdomain value, rather than only trimming a trailing dot. This parameter has no effect unless you also pass the topdomain parameter.
- 1 - Remove dots from the subdomain label.
- 0 - Do not remove dots from the subdomain label.
Accepted for compatibility, but ignored for account-level callers. It can no longer cause the system to skip the domain name, DNS, and registration checks, or to overwrite an existing DNS zone.
The system still refuses to create a domain that another account owns.
- 0 - Enforce the checks.
- 1 - Accepted, but has no effect for account-level callers.
The subdomain label of the account's primary domain to park the domain value on. The system appends the primary domain to this value.
Omit this parameter to park the domain on the primary domain itself.
Response
HTTP Request was successful.
Example response
{
"status": 1
}Changes
No recorded changes to this operation across all 5 revisions of this API.