Description


This function queries files and directories.


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


Examples 




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



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

 



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

 




cpapi2 --user=username Fileman autocompletedir dirsonly=1 path=%2Fhome%2Fuser%2Fpublic_html%2F



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



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.

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