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

Versions Compared

Key

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

Description


Excerpt

This function queries files and directories.


Warning
titleWarning:

We strongly recommend that you use the following UAPI function instead of this function:

  • Fileman::autocompletedir —

    Excerpt Include
    DD:UAPI Functions - Fileman::autocompletedir
    DD:UAPI Functions - Fileman::autocompletedir
    nopaneltrue


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=autocompletedir&dirsonly=1&path=%2Fhome%2Fuser%2Fpublic_html

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Search for directories that begin with /home/user/public_html.
$search_directories = $cpanel->api2(
    'Fileman', 'autocompletedir', 
		array(
		'dirsonly' 				=> '1'
		'path'					=> '/home/user/public_html/'
    ) 
);

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.
 
# Search for directories that begin with /home/user/public_html.
my $search_directories = $cpliveapi->api2(
    'Fileman', 'autocompletedir',
	{
		'dirsonly' 				=> '1'
		'path'					=> '/home/user/public_html/'
	}	
 );

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 autocompletedir dirsonly=1 path=%2Fhome%2Fuser%2Fpublic_html%2F

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
   "cpanelresult" : {
      "apiversion" : 2,
      "data" : [
         {
            "file" : "public_html"
         },
         {
            "file" : "public_ftp"
         }
      ],
      "event" : {
         "result" : 1
      },
      "func" : "autocompletedir",
      "module" : "Fileman",
      "postevent" : {
         "result" : 1
      },
      "preevent" : {
         "result" : 1
      }
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
dirsonlyBoolean

Whether to only return directories.

This parameter defaults to 0.

  • 1 — Return directories.
  • 0 — Return files and directories.
1
pathstring

The path to the directory to query.

This parameter defaults to the user's /home directory.

The absolute path to a location on the server./home/user/public_html

 

Returns

ReturnTypeDescriptionPossible valuesExample
filestringThe queried filename or path.The path input parameter's value.public_html
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