cPanel API 2 Functions - Fileman::getpath - Knowledgebase

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.

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

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

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

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

Notes:

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

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

Parameters

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

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

Returns

Return	Type	Description	Possible values	Example
dirparts	hash	An array of the cPanel account's directories and subdirectories.	This hash contains thedirurl anddirpartreturns.
dirurl	string	The subdirectory's path. The function returns this value in the dirpartshash.	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 dirpartshash.	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. 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

Knowledgebase

Categories

Categories