# cPanel API 2 Functions - Fileman::getdiractions

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 lists possible directory actions.

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

Important:
When you disable the [*File Storage* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## 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=Fileman&cpanel_jsonapi_func=getdiractions&dir=%2Fhome%2Fcolin%2Fpublic_html&file=public_html
```

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.

// Search for directories that begin with /home/user/public_html.
$search_directories = $cpanel->api2(
    'Fileman', 'Autocompletedir',
        array(
        'dirsonly'              => '1'
        'path'                  => '/home/user/public_html/'
    )
);
```

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.

# Search for directories that begin with /home/user/public_html.
my $search_directories = $cpliveapi->api2(
    'Fileman', 'autocompletedir',
    {
        'dirsonly'              => '1'
        'path'                  => '/home/user/public_html/'
    }   
 );
```

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

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": "getfileactions",
        "data": [{
            "actions": [{
                    "actionname": "Show File Contents",
                    "target": "viewer",
                    "actionurl": "showfile.html?dir=%2fhome%2fcolin&file=",
                    "action": "showcontents"
                },
                {
                    "actionname": "Delete File",
                    "target": "file",
                    "actionurl": "trashit.html?dir=%2fhome%2fcolin&file=",
                    "action": "delete"
                },
                {
                    "actionname": "Change Permissions",
                    "target": "file",
                    "actionurl": "perm.html?dir=%2fhome%2fcolin&file=",
                    "action": "chmod"
                },
                {
                    "actionname": "Rename File",
                    "target": "file",
                    "actionurl": "rename.html?dir=%2fhome%2fcolin&file=",
                    "action": "rename"
                },
                {
                    "actionname": "Copy File",
                    "target": "dir",
                    "actionurl": "fileop.html?opdir=%2fhome%2fcolin&opfile=&fileop=copy",
                    "action": "copy"
                },
                {
                    "actionname": "Move File",
                    "target": "dir",
                    "actionurl": "fileop.html?opdir=%2fhome%2fcolin&opfile=&fileop=move",
                    "action": "move"
                },
                {
                    "actionname": "Download File",
                    "target": "file",
                    "actionurl": "/cpsess##########/download?file=%2fhome%2fuser/",
                    "action": "download"
                }
            ],
            "fileinfo": "Contains 5 items",
            "file": "public_html",
            "mimename": "homeb",
            "mimetype": "homeb",
            "dir": "/home/user"
        }],
        "event": {
            "result": 1
        },
        "module": "Fileman"
    }
}
```

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
Parameter
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
p
code
dir
td
em
string
td
p
strong
Required
p
The base directory's path.
td
A valid absolute file path.
td
code
/home/user
tr
td
code
file
td
em
string
td
p
strong
Required
p
The file or directory to search.
td
A valid filename or directory name on the server.
td
code
public_html
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
actions
td
em
hash
td
A hash of action options.
td
This has contains the 
code
actionname
, 
code
target
, 
code
actionurl
, and 
code
action
 returns.
td
br
tr
td
p
code
actionname
td
em
string
td
p
The action to perform on the file or directory.
p
The function returns this value in the 
code
actions
 hash.
td
p
An available action.
td
code
Show File Contents
tr
td
p
code
target
td
em
string
td
p
The target of the action.
p
The function returns this value in the 
code
actions
 hash.
td
ul
li
code
dir
 — Perform this action on the directory.
li
code
file — 
Perform this action on the file.
code
li
code
editor
 — Perform this action on the HTML editor.
td
code
viewer
tr
td
p
code
actionurl
td
em
string
td
p
The URL fragment to append to a 
em
File Manager
 URL.
p
The function returns this value in the 
code
actions
 hash.
td
A URL fragment.
td
code
showfile.html?dir=%2fhome%2fexample
&
file
tr
td
p
code
action
td
em
string
td
p
The action for the file or directory.
p
The function returns this value in the 
code
actions
 hash.
td
An available action.
td
code
showcontents
tr
td
code
file
td
em
string
td
The file that the function queried.
td
A valid filename.
td
code
public_html
tr
td
code
mimename
td
em
string
td
The file's MIME name.
td
span
A valid MIME type.
td
code
homeb
tr
td
code
mimetype
td
em
string
td
The file's MIME type.
td
A valid MIME type.
td
code
homeb
tr
td
code
dir
td
em
string
td
The directory that the function queried.
td
A full filepath.
td
code
/home/user
tr
td
code
reason
td
em
string
td
p
A reason for failure
p
This function only returns a 
code
reason
 value if an error occurred.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1