Child pages
  • UAPI Functions - SubDomain::addsubdomain
Skip to end of metadata
Go to start of metadata

Description

This function creates a subdomain.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 WHM API (JSON)
https://hostname.example.com:2083/cpsess##########/execute/SubDomain/addsubdomain?domain=subdomain&rootdomain=example.com&dir=%2Fpublic_html%2Fdirectory_name&disallowdot=1


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


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


Note:

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

 

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{  
   "errors":null,
   "messages":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}


Note:

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

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:

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.