cPanel API 2 Functions - Fileman::getdir

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the File Storage role, the system disables this function.

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

Note:

For more information, read our Calls from the WHM API documentation.

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

Note:

For more information, read our Guide to the LiveAPI System.

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

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI 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 .
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 documentation.

Command Line

cpapi2 --user=username Fileman getdir

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 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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

Parameters

Parameter Type Description Possible values Example

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

dir

string

The directory for which to retrieve the file path.

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

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

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.

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