# cPanel API 2 Functions - SubDomain::changedocroot

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function changes a subdomain's document root.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


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

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
    "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
strong
Parameter
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
subdomain
td
em
string
td
p
strong
Required
p
The subdomain for which to change the document root.
td
p
A valid domain name.
td
span
code
subdomain
br
tr
td
code
rootdomain
td
em
string
td
p
strong
Required
p
The main domain of the subdomain for which to change the document root.
td
A domain that already exists on the cPanel account.
td
code
example.com
tr
td
code
dir
td
em
string
td
p
strong
Required
p
The document root to which to move the subdomain.
p
span
A valid directory path, relative to the user's home directory.
p
You 
strong
cannot
 use the following directories as a document root:
ul
li
The account's home directory itself (
code
/
)
li
Directories outside of the account's home directory (
code
./
 and 
code
../
)
li
code
.cpanel
li
code
.trash
li
code
etc
li
code
mail
li
code
ssl
li
code
tmp
li
code
logs
li
code
.cphorde
li
code
.spamassassin
li
code
.htpasswds
li
code
var
li
code
cgi-bin
li
code
.ssh
li
code
perl5
p
span
br
td
code
/public_html/directory_name
## Returns

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