Description

This function adds a subdomain to a domain.

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$add_domain = $cpanel->api1('SubDomain','addsubdomain', array('subdomain','example.com','0','1','public_html/subdomain') ); // Call the function.

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $add_domain = $cpliveapi->api1('SubDomain','addsubdomain', ['subdomain','example.com','0','1','public_html/subdomain'] ); # Call the function.

 

<cpanel Module="SubDomain::addsubdomain( $FORM('domain','rootdomain','canoff','disallowdot','dir') )">
cpapi1 --user=username SubDomain addsubdomain subdomain example.com 0 1 public_html/subdomain

The subdomain "subdomain.example.com" has been added.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
domain

string

Required

The subdomain to add.

A valid subdomain string.subdomain
rootdomainstring

Required

The domain name.

A valid domain name.example.com
canoffBoolean

Whether to create a wildcard subdomain.

This value defaults to 0.

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

Whether to strip the dots from the domain parameter.

This value defaults to 0.

  • 1 — Strip all dots.
  • 0 — Strip only the trailing dot.
1
dirstring

The path to the subdomain's document root, relative to the account's home directory.

This value defaults to public_html.

A valid relative path.
public_html/subdomain

Returns

This function returns a confirmation message.