cPanel API 2 Functions - DomainLookup::getdocroot - Knowledgebase

Description

This function retrieves a domain's document root file paths.

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

 LiveAPI PHP Class

$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',
   )
);

 LiveAPI Perl Module

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',
        }
 );

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.

 Output (JSON)

{
  "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 interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	The domain. This value defaults to the account's main domain. Note: The account must own this domain.	Any valid domain.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

The domain.

This value defaults to the account's main domain.

Note:

The account must own this domain.

Any valid domain.

example.com

Returns

Return	Type	Description	Possible values	Example
reldocroot	string	The document root's relative path.	The document root's file path, relative to the user's home directory.	public_html
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 reason value 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

Knowledgebase

Categories

Categories