cPanel API 2 Functions - Fileman::getdir - Knowledgebase

Description

This function returns an account's home directory's path in URI-encoded format.

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=Fileman&cpanel_jsonapi_func=getdir&dir=public_html

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Returns an account's home directory file path.

$getdir = $cpanel->api2(

'Fileman', 'getdir'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Returns an account's home directory file path.

my $getdir = $cpliveapi->api2(

'Fileman', 'getdir',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly 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 Fileman getdir

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getdir",
    "data": [
      {
        "dir": "%2fhome%2fexample%2fpublic_html"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	The directory for which to retrieve the file path. Note: Regardless of whether you use this parameter, the function will return the dir value.	A valid directory on the server.	public_html

Parameter

Type

Description

Possible values

Example

dir

string

The directory for which to retrieve the file path.

Note:

Regardless of whether you use this parameter, the function will return the dir value.

A valid directory on the server.

public_html

Returns

Return	Type	Description	Possible values	Example
dir	string	The absolute path to the account's home directory.	A valid path, in URI-encoded format.	%2fhome%2fexample%2fpublic_html
reason	string	A reason for failure. Note: This function only returns a reason value if an error occurred.	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