Description
This function retrieves all of the domains' document root file paths.
Examples
WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=DomainLookup&cpanel_jsonapi_func=getdocroots
LiveAPI PHP Class
$cpanel = new CPANEL();
$get__doc_roots = $cpanel->api2(
'DomainLookup', 'getdocroots'
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $get_doc_roots = $cpliveapi->api2(
'DomainLookup', 'getdocroots',
);
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
Command Line
cpapi2 --user=username DomainLookup getdocroots
|
Output (JSON)
{
"cpanelresult": {
"apiversion": 2,
"func": "getdocroots",
"data": [
{
"domain": "example.com",
"docroot": "/home/user/public_html"
},
{
"domain": "example2.com",
"docroot": "/home/user/public_html/example2"
}
],
"event": {
"result": 1
},
"module": "DomainLookup"
}
}
Parameters
This function does not accept parameters.
Returns
|
Return
|
Type
|
Description
|
Possible values
|
Example
|
|
domain
|
string
|
The document root's domain.
|
A valid domain name.
|
example.com
|
|
docroot
|
string
|
The document root's absolute path.
|
An absolute file path.
|
/home/user/public_html
|
|
reason
|
string
|
A reason for failure.
Note:
This function only returns a reasonvalue if there was an error.
|
A string that describes the error.
|
This is an error message.
|
|
result
|
Boolean
|
Whether the function succeeded.
|
- 1 — The function succeeded.
- 0 — The function failed.
|
1
|
