Child pages
  • UAPI Functions - SubDomain::addsubdomain

Versions Compared

Key

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

Description

Excerpt
This function creates a subdomain.

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:2083/cpsess##########/execute/SubDomain/addsubdomain?domain=subdomain&rootdomain=example.com&dir=%2Fpublic_html%2Fdirectory_name&disallowdot=1

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Create a subdomain.
$get_userdata = $cpanel->uapi(
    'SubDomain', 'addsubdomain', 
        array(
        'domain'                => 'subdomain',
        'rootdomain'            => 'example.com',
        'dir'              		=> '/public_html/directory_name',
        'disallowdot'           => '1',
    )
);

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.
 
# Create a subdomain.
my $get_userdata = $cpliveapi->uapi(
    'SubDomain', 'addsubdomain',
 	{
        'domain'                => 'subdomain',
        'rootdomain'            => 'example.com',
        'dir'              		=> '/public_html/directory_name',
        'disallowdot'           => '1',
    } 
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 



Expand
titleCommand Line


Code Block
languagetext
uapi --user=username SubDomain addsubdomain domain=subdomain rootdomain=example.com dir=%2Fpublic_html%2Fdirectory_name disallowdot=1

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "errors":null,
   "messages":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
domainstring

Required

The subdomain name to create.

A valid subdomain name.

subdomain
rootdomainstring

Required

The domain on which to create the new subdomain.

A domain that already exists on the cPanel account.example.com
canoffBoolean

Whether to create a wildcard subdomain.

This value defaults to 1.

  • 1 — Create a wildcard subdomain.
  • 0 — Create a normal subdomain.
1
dirstring

The subdomain's document root within the home directory.

This value defaults to the user's home directory /public_html/ path.

Note
titleNote:

If the Restrict document roots to public_html value is set to Off in WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings), this parameter defaults to the /username/ path. For example, the username user's subdomain example would default to the /home/username/example path.


A valid directory path, relative to the user's home directory./public_html/directory_name
disallowdotBoolean

Whether to remove the dots (.) from the domain value.

This value defaults to 0.

  • 1 — Remove dots from the domain.
  • 0 — Do not remove dots.
1

Returns

This function only returns metadata.