cPanel API 2 Functions - SubDomain::changedocroot

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function changes a subdomain's document root.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=SubDomain&cpanel_jsonapi_func=changedocroot&subdomain=subdomain&rootdomain=example.com&dir=public_html%2Fnew_directory

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.

// Change a subdomain's document root.
$changedocroot = $cpanel->api2(
    'SubDomain', 'changedocroot',
        array(
        'subdomaindomain'       => 'subdomain'
        'rootdomain'            => 'example.com'
        'dir'                   => '/public_html/directory_name'
    )
);

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.

# Change a subdomain's document root.
my $changedocroot = $cpliveapi->api2(
    'SubDomain', 'changedocroot',
    {
        'subdomain'             => 'subdomain'
        'rootdomain'            => 'example.com'
        'dir'                   => '/public_html/directory_name'
    }
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username SubDomain changedocroot subdomain=subdomain rootdomain=example.com dir=%2Fpublic_html%2Fdirectory_name

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
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)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "changedocroot",
        "data": [{
            "reason": "",
            "reldir": "public_html/new_directory",
            "result": 1,
            "dir": "/home/example/public_html/new_directory"
        }],
        "event": {
            "result": 1
        },
        "module": "SubDomain"
    }
}

Note:

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

Parameters

A valid directory path, relative to the user's home directory.

You cannot use the following directories as a document root:

The account's home directory itself (/)
Directories outside of the account's home directory (./ and ../)
.cpanel
.trash
etc
mail
ssl
tmp
logs
.cphorde
.spamassassin
.htpasswds
var
cgi-bin
.ssh
perl5

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`subdomain`	string	Required The subdomain for which to change the document root.	A valid domain name.	`subdomain`
`rootdomain`	string	Required The main domain of the subdomain for which to change the document root.	A domain that already exists on the cPanel account.	`example.com`
`dir`	string	Required The document root to which to move the subdomain.	`/public_html/directory_name`

subdomain

string

Required

The subdomain for which to change the document root.

A valid domain name.

subdomain

rootdomain

string

Required

The main domain of the subdomain for which to change the document root.

A domain that already exists on the cPanel account.

example.com

dir

string

Required

The document root to which to move the subdomain.

/public_html/directory_name

Returns

Return	Type	Description	Possible values	Example
`reason`	string	A reason for failure. This function only returns a `reason` value if there was an error.	A string that describes the error.	`This is an error message.`
`reldir`	string	The path to the subdomain's document root, relative to the cPanel account's home directory.	A valid directory path, relative to the user's home directory.	`public_html/new_directory`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`
`dir`	string	The absolute path to the subdomain's document root.	The absolute path to the addon domain's document root.	`/home/example/public_html/new_directory`