Description

This function creates a subdomain.

Examples




https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SubDomain&cpanel_jsonapi_func=addsubdomain&domain=subdomain&rootdomain=example.com&dir=%2Fpublic_html%2Fdirectory_name&disallowdot=1



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

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Create a subdomain.
my $addsubdomain = $cpliveapi->api2(
    'SubDomain', 'addsubdomain',
 	{
        'domain'                => 'subdomain',
        'rootdomain'            => 'example.com',
        'dir'              		=> '/public_html/directory_name',
        'disallowdot'           => '1',
    } 

);

 




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



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "addsubdomain",
    "data": [
      {
        "reason": "The subdomain "subdomain.example.com" has been added.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "SubDomain"
  }
}



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 0.

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

The subdomain's document root within your home directory.

This parameter's default depends on the server's settings:

  • cPanel & WHM version 58 and higher:
  • cPanel & WHM version 56 and earlier:
    • If the public_html subdomains only value is On, the parameter defaults to the public_html/subdomain_name path, where subdomain_name is the subdomain's name .
    • If the public_html subdomains only value is Off, the parameter defaults to the subdomain_name path, where subdomain_name is the subdomain's name.

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

ReturnTypeDescriptionPossible valuesExample
reasonstring

A message of success or a reason for failure.

A string that describes the success or error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1