Description

This function lists possible directory actions.

Examples 




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



$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/'
    ) 
);

 



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/'
	}	
 );

 




cpapi2 --user=username Fileman autocompletedir disonly=1 path=%2Fhome%2Fuser%2Fpublic_html%2F



{
  "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"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample

dir

string

Required

The base directory's path.

A valid absolute file path./home/user
filestring

Required

The file or directory to search.

A valid filename or directory name on the server.public_html

Returns

ReturnTypeDescriptionPossible valuesExample
actionshashA hash of action options.This has 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.

An available action.

Show File Contents

target

string

The target of the action.

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.

An available action.
showcontents
filestringThe file that the function queried.A valid filename.public_html
mimenamestringThe file's MIME name.A valid MIME type.homeb
mimetypestringThe file's MIME type.A valid MIME type.
homeb
dirstringThe directory that the function queried.A full filepath./home/user
reasonstring

A reason for failure

This function only returns a reason value if an error occurred.


A string that describes the error. This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1