latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

DNS
Domain Management

Create domain alias

This function creates an alias (parks a domain on a web virtual host).

get/create_parked_domain_for_user

Query parameters

domainstring domain required
Example:park.example.com

The domain name to park.

usernamestring required
Example:username

The cPanel user account.

web_vhost_domainstring required
Example:vhost.example.com

An existing web virtual host to which the new domain name should be added.

Note:

If this is not the cPanel account’s main domain, then the system will consider the new domain to be an addon domain.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "create_parked_domain_for_user",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}