# cPanel API 2 Functions - FSTest::dirisempty

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function checks whether a directory is empty.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined 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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined 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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined 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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username FSTest dirisempty dir=%2Fhome%2Fuser%2Fpublic_html%2Fsubdomain%2F files_only=1 regex_ext=\.txt
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

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


br
Output (JSON)


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

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

Note:
Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
Input
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
dir
td
em
string
td
p
strong
Required
p
The directory's file path.
td
Any valid file path.
td
code
/home/user/public_html/subdomain/
tr
td
code
files_only
td
em
Boolean
td
p
span
Whether to return only directories that contain files as not empty.
p
span
This parameter defaults to 
code
0
.
td
ul
li
code
1
 — Display 
strong
only
 directories that contain files.
li
code
0
 — Display all directories.
td
code
1
tr
td
code
regex_ext
td
em
string
td
p
A 
a
Perl Compatible Regular Expression (PCRE)
 that filters the results by file extension.
p
If you do not use this parameter, the function will 
strong
not
 filter the results by file extension.
td
A valid PCRE.
td
code
\.txt
## Returns

table
thead
tr
th
Return
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
data
td
em
array
td
Whether the specified directory exists and matches the 
code
files_only
 parameter's criteria.
td
ul
li
code
1
 — Matches 
code
files_only.
li
N/A — Does 
strong
not
 match 
code
files_only
.
td
code
1
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if there was an error.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1