Skip to content
Last updated

cPanel API 2 Functions - FSTest::dirisempty

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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)

syntaxhighlighter-pre
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
Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

syntaxhighlighter-pre
$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',
            )
 );
Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

syntaxhighlighter-pre
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',
    }
 );
Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:
  • cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

syntaxhighlighter-pre
cpapi2 --user=username FSTest dirisempty dir=%2Fhome%2Fuser%2Fpublic_html%2Fsubdomain%2F files_only=1 regex_ext=\.txt
Notes:
  • You must URI-encode values.

  • username represents your account-level username.

  • You must include the --user=username option.

  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.

  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    syntaxhighlighter-pre
    /usr/local/cpanel/bin/cpapi2

Output (JSON)

syntaxhighlighter-pre
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "dirisempty",
    "data": [

    ],
    "event": {
      "result": 1
    },
    "module": "FSTest"
  }
}
Note:

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

Parameters

InputTypeDescriptionPossible valuesExample
dirstring

Required

The directory's file path.

Any valid file path./home/user/public_html/subdomain/
files_onlyBoolean

Whether to return only directories that contain files as not empty.

This parameter defaults to 0.

  • 1 — Display only directories that contain files.
  • 0 — Display all directories.
1
regex_extstring

A Perl Compatible Regular Expression (PCRE) that filters the results by file extension.

If you do not use this parameter, the function will not filter the results by file extension.

A valid PCRE.\.txt

Returns

ReturnTypeDescriptionPossible valuesExample
dataarrayWhether the specified directory exists and matches the files_only parameter's criteria.
  • 1 — Matches files_only.
  • N/A — Does not match files_only.
1
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.
resultBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1