cPanel API 2 Functions - Fileman::getpath

Warning:

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

Description

This function splits a URI-encoded path into individual parts.

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=getpath&dir=/home/user/public_html/new_directory

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.

// Splits a URI-encoded directory path into individual parts.
$getpath = $cpanel->api2(
    'Fileman', 'getpath',
        array(
        'dir'               => '/home/user/public_html/new_directory'
    )
);

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.

# Splits a URI-encoded directory path into individual parts.
my $getpath = $cpliveapi->api2(
    'Fileman', 'getpath',
    {
        'dir'               => '/home/user/public_html/new_directory'
    }   
 );

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 getpath dir=%2Fhome%2Fuser%2Fpublic_html%2Fnew_directory

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,
        "preevent": {
            "result": 1
        },
        "postevent": {
            "result": 1
        },
        "func": "getpath",
        "data": [
            {
                "dirparts": [
                    {
                        "dirurl": "/public_html/",
                        "dirpart": "public_html"
                    },
                    {
                        "dirurl": "/public_html/subdomain.example.com/",
                        "dirpart": "subdomain.example.com"
                    }
                ],
                "dir": "/home/user/public_html/subdomain.example.com"
            }
        ],
        "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	Required The directory's path.	The absolute path to the directory's location on the server.	`/home/user/public_html/new_directory`

dir

string

Required

The directory's path.

The absolute path to the directory's location on the server.

/home/user/public_html/new_directory

Returns

Return	Type	Description	Possible values	Example
`dirparts`	hash	An array of the cPanel account's directories and subdirectories.	This hash contains the `dirurl` and `dirpart` returns.
`dirurl`	string	The subdirectory's path. The function returns this value in the `dirparts` hash.	A valid directory path, relative to the user's home directory.	`/public_html/`
`dirpart`	string	The subdirectory's name. The function returns this value in the `dirparts` hash.	A valid directory name.	`public_html`
`dir`	string	The directory's path.	The absolute path to the directory's location on the server.	`/home/user/public_html/subdomain.example.com`
`reason`	string	A reason for failure. 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`