Child pages
  • cPanel API 2 Functions - AddonDomain::addaddondomain

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


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

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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
titleNote:

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


Note
titleNote:

Include Page
LIB:_Banned Docroots Relative to Home Directory
LIB:_Banned Docroots Relative to Home Directory


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