# cPanel API 2 Functions - DomainLookup::getdocroot

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 retrieves a domain's document root file paths.

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=DomainLookup&cpanel_jsonapi_func=getdocroot&domain=example.com
```

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

// Retrieve document root file paths for example.com.
$get__doc_root = $cpanel->api2(
    'DomainLookup', 'getdocroot',
        array(
        'domain'        => 'example.com',
    )
);
```

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

# Retrieve document root file paths for example.com.
my $get_doc_root = $cpliveapi->api2(
    'DomainLookup', 'getdocroot',
        {
        'domain'        => 'example.com',
        }
 );
```

div
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 DomainLookup getdocroot domain=example.com
```

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
```


Output (JSON)


```undefined syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getdocroot",
    "data": [
      {
        "reldocroot": "public_html",
        "docroot": "/home/user/public_html"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "DomainLookup"
  }
}
```

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
Parameter
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
domain
td
em
string
td
div
p
The domain.
p
This value defaults to the account's main domain.
p
The account 
strong
must
 own this domain.
td
Any valid domain.
td
code
example.com
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
reldocroot
td
em
string
td
The document root's relative path.
td
span
The document root's file path, relative to the user's home directory
.
td
code
public_html
tr
td
code
docroot
td
em
string
td
The document root's absolute path.
td
An absolute file path.
td
code
/home/user/public_html
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function 
strong
only
 returns a 
code
reason
 value if there was an error. 
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
p
br
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1