Child pages
  • cPanel API 2 Functions - Fileman::getpath

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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'
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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'
	}	
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Fileman getpath dir=%2Fhome%2Fuser%2Fpublic_html%2Fnew_directory

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
   "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"
    }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample

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

ReturnTypeDescriptionPossible valuesExample
dirpartshashAn 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
dirstringThe directory's path.The absolute path to the directory's location on the server.
/home/user/public_html/subdomain.example.com
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if there was an error.


A string that describes the error.This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1