cPanel API 2 Functions - FSTest::dirisempty - Knowledgebase

Description

This function checks whether a directory is empty.

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=FSTest&cpanel_jsonapi_func=dirisempty&dir=%2Fhome%2Fcolin%2Fpublic_html&files_only=1&regex_ext=%2F.txt

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check if /home/user/public_html/subdomain/ is empty.
$check_directory = $cpanel->api2(
    'FSTest', 'dirisempty',
        array(       
            'dir'           => '/home/user/public_html/subdomain/',
            'files_only'    => '1',
            'regex_ext'     => '\.txt',
            )
 );

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check if /home/user/public_html/subdomain/ is empty.
my $check_directory_ = $cpliveapi->api2(
    'FSTest', 'dirisempty',
    {
            'dir'           => '/home/user/public_html/subdomain/',
            'files_only'    => '1',
            'regex_ext'     => '\.txt',
    }
 );

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "dirisempty",
    "data": [
       
    ],
    "event": {
      "result": 1
    },
    "module": "FSTest"
  }
}

Note:

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

Parameters

Input	Type	Description	Possible values	Example
dir	string	Required The directory's file path.	Any valid file path.	/home/user/public_html/subdomain/
files_only	boolean	Whether to return only directories that contain files as not empty.	1 — The directory must contain files. 0 — The directory does not have to contain files.	1
regex_ext	string	A Perl Compatible Regular Expression (PCRE) that filters the results by file extension.	A valid PCRE.	\.txt

Returns

Input	Type	Description	Possible values	Example
dir	string	Required The directory's file path.	Any valid file path.	/home/user/public_html/subdomain/
files_only	boolean	Whether to return only directories that contain files as not empty.	1 — The directory must contain files. 0 — The directory does not have to contain files.	1
regex_ext	string	A Perl Compatible Regular Expression (PCRE) that filters the results by file extension.	A valid PCRE.	\.txt

Knowledgebase

Categories

Categories