cPanel API 2 Functions - Fileman::getabsdir - Knowledgebase

Description

This function lists cPanel's current directory. The default directory is the / usr/local/cpanel/base/ directory.

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=getabsdir

LiveAPI PHP Class

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

// Lists the current directory.

$getabsdir = $cpanel->api2(

'Fileman', 'getabsdir'

);

LiveAPI Perl Module

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

# Lists the current directory.

my $getabsdir = $cpliveapi->api2(

'Fileman', 'getabsdir',

);

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 getabsdir

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "module": "Fileman",
    "apiversion": 2,
    "func": "getabsdir",
    "data": [
      {
        "absdir": "/usr/local/cpanel/base"
      }
    ],
    "event": {
      "result": 1
    }
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
absdir	string	The path to return. This parameter defaults to the / usr/local/cpanel/base/ directory.	Any valid directory, relative to the account's /home directory.	public_html

Parameter

Type

Description

Possible values

Example

absdir

string

The path to return.

This parameter defaults to the / usr/local/cpanel/base/ directory.

Any valid directory, relative to the account's /home directory.

public_html

Returns

Return	Type	Description	Possible values	Example
absdir	string	The absolute path to the account's current working directory.	A valid absolute path.	/usr/local/cpanel/base
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

Knowledgebase

Categories

Categories