cPanel API 2 Functions - Fileman::getdiractions

Description

This function lists possible directory actions.

Warning:

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

 

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

 

 Command Line

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

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (JSON)

{
  "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 interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

 Parameter 

 Type 

Description

Possible values

Example

 dir

 string 

 Required

 The base directory's path.

 A valid absolute file path.

 /home/user 

 file

 string

 Required

 The file or directory to search. 

 A valid filename or directory name on the server. 

 public_html

 

 

Returns

Return

Type

Description

Possible values

Example

 actions

 hash

 A hash of action options.

 This has contains theactionname,target,actionurl, andaction 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

 file

 string 

 The file that the function queried.

 A valid filename.

 public_html

 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.

 A full filepath.

 /home/user

 reason

 string

 A reason for failure

 Note:

 This function only returns a reasonvalue if an error occurred. 

 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

  

 
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....