Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
cPanel API 2 Functions - AddonDomain::addaddondomain - Software Development Kit - cPanel Documentation
Page tree
Skip to end of metadata
Go to start of metadata

 

Description

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


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=AddonDomain&cpanel_jsonapi_func=addaddondomain&dir=addondomain%2Fhome%2Fdir&newdomain=addondomain.com&subdomain=subdomain.example.com


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$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',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
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',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 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.

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

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


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

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.

Note:

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