cPanel API 2 Functions - Fileman::getfileactions

Warning:

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

Description

This function lists possible file actions.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:

When you disable the File Storage role, the system disables this function.

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=getfileactions&dir%2Fhome%2Fuser&file=public_html&newedit=0

Note:

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

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List possible file actions.
$search_directories = $cpanel->api2(
    'Fileman', 'getfileactions',
        array(
        'file'                  => 'public_html'
        'dir'                   => '/home/user'
        'newedit'               => '0'
    )
);

Note:

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

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List possible file actions.
my $search_directories = $cpliveapi->api2(
    'Fileman', 'getfileactions',
    {
        'dir'                   => '/home/user'
        'file'                  => 'public_html'
        'newedit'               => '0'
    }   
 );

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

cpapi2 --user=username Fileman getfileactions dir=%2Fhome%2Fuser file=public_html newedit=0

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:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
    "cpanelresult": {
        "apiversion": 2,
        "func": "getfileactions",
        "data": [{
            "actions": [{
                    "actionname": "Show File Contents",
                    "target": "viewer",
                    "actionurl": "showfile.html?dir=%2fhome%2fexample&file=",
                    "action": "showcontents"
                },
                {
                    "actionname": "Delete File",
                    "target": "file",
                    "actionurl": "trashit.html?dir=%2fhome%2fexample&file=",
                    "action": "delete"
                },
                {
                    "actionname": "Change Permissions",
                    "target": "file",
                    "actionurl": "perm.html?dir=%2fhome%2fexample&file=",
                    "action": "chmod"
                },
                {
                    "actionname": "Rename File",
                    "target": "file",
                    "actionurl": "rename.html?dir=%2fhome%2fexample&file=",
                    "action": "rename"
                },
                {
                    "actionname": "Copy File",
                    "target": "dir",
                    "actionurl": "fileop.html?opdir=%2fhome%2fexample&opfile=&fileop=copy",
                    "action": "copy"
                },
                {
                    "actionname": "Move File",
                    "target": "dir",
                    "actionurl": "fileop.html?opdir=%2fhome%2fexample&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 interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`dir`	string	Required The base directory's path.	A valid absolute directory path.	`/home/user`
`file`	string	Required The file or directory to search.	Any valid filename or directory name on the server.	`public_html`
`newedit`	Boolean	Whether to return URLs and targets for the `file` or `editor` parameter's values. This parameter defaults to `0`.	`1` — Return URLs and targets for the `file` value. `0` — Return URLs and targets for the `dir` value.	`1`

dir

string

Required

The base directory's path.

A valid absolute directory path.

/home/user

file

string

Required

The file or directory to search.

Any valid filename or directory name on the server.

public_html

newedit

Boolean

Whether to return URLs and targets for the file or editor parameter's values.

This parameter defaults to 0.

1 — Return URLs and targets for the file value.
0 — Return URLs and targets for the dir value.

1

Returns

Return	Type	Description	Possible values	Example
`actions`	hash	A hash of action options.	This hash contains the `actionname`, `target`, `actionurl`, and `action` returns.
`actionname`	string	The action to perform on the file or directory. The function returns this value in the `actions` hash.	A valid string.	`Show File Contents`
`target`	string	The action's target. The function returns this value in the `actions` hash.	`dir` — Perform this action on the directory. `file —` Perform this action on the file. `editor` — Perform this action on the HTML editor.	`viewer`
`actionurl`	string	The URL fragment to append to a File Manager URL. The function returns this value in the `actions` hash.	A URL fragment.	`showfile.html?dir=%2fhome%2fexample&file`
`action`	string	The action for the file or directory. The function returns this value in the `actions` hash.	A valid string.	`showcontents`
`file`	string	The file that the function queried.	A valid filename.	`public_html`
`fileinfo`	string	A description of file.	A string that describes any additional information about the file.	`Contains 5 items.`
`mimename`	string	The file's MIME name.	A valid MIME type.	`homeb`
`mimetype`	string	The file's MIME type.	A valid MIME type.	`homeb`
`dir`	string	The directory that the function queried.	An absolute file path.	`/home/user`
`reason`	string	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.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`