Description

This function creates an addon domain, its subdomain, its FTP account, and its DNS zone.

Examples 




https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=AddonDomain&cpanel_jsonapi_func=addaddondomain&dir=addondomain%2Fhome%2Fdir&newdomain=addondomain.com&subdomain=subdomain.example.com



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add the "addondomain.com" addon domain.
$add_addon = $cpanel->api2(
    'AddonDomain', 'addaddondomain', 
    array(
        'dir'            => 'addondomain/home/dir', 
        'newdomain'      => 'addondomain.com', 
        'subdomain'      => 'subdomain',
    ) 
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Add the "addondomain.com" addon domain.
my $add_addon = $cpliveapi->api2(
    'AddonDomain', 'addaddondomain',
    { 
        'dir'            => 'addondomain/home/dir', 
        'newdomain'      => 'addondomain.com', 
        'subdomain'      => 'subdomain',
    }
);




cpapi2 --user=username AddonDomain addaddondomain dir=addondomain%2Fhome%2Fdir newdomain=addondomain.com subdomain=subdomain 



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addaddondomain",
    "data": [
      
    ],
    "event": {
      "result": 1
    },
    "module": "AddonDomain"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

The path to the addon domain's home directory.

If you do not specify a value, this parameter defaults to the user's document root.

A valid path relative to the cPanel user's home directory.

In WHM API calls, replace the forward slash (/) with %2F.



addondomain/home/dir
newdomainstring

Required

The addon domain name.

A valid domain name that does not already exist.

addondomain.com
subdomainstring

Required

The addon domain's subdomain name.

A valid subdomain name that does not already exist. For example, for the subdomain.example.com subdomain, specify subdomain.

The cPanel user must own the subdomain's main domain. For example, for the subdomain.example.com subdomain, the cPanel user must already own example.com .

subdomain

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstring

A message of success or a reason for failure.

  • addondomain.com was successfully parked on top of subdomain.example.com — This message indicates that the system successfully added the addon domain.
  • A string that describes the error.
This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1