cPanel API 2 Functions - Fileman::autocompletedir - Knowledgebase

Description

This function queries files and directories.

Warning:

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

Fileman::autocompletedir — This function returns any files and directories that begin with a specified string.

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

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

Notes:

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

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
dirsonly	Boolean	Whether to only return directories. This parameter defaults to 0.	1 — Return directories. 0 — Return files and directories.	1
path	string	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

Parameter

Type

Description

Possible values

Example

dirsonly

Boolean

Whether to only return directories.

This parameter defaults to 0.

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

path

string

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

Return	Type	Description	Possible values	Example
file	string	The queried filename or path.	The path input parameter's value.	public_html
reason	string	A reason for failure. Note: 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

Knowledgebase

Categories

Categories