cPanel API 2 Functions - Fileman::mkdir - Knowledgebase

Description

This function creates a 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=mkdir&path=public_html&name=new_directory

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Create a directory.
$mkdir = $cpanel->api2(
    'Fileman', 'mkdir', 
        array(
        "path"          =>       "/home/example/public_html",
        "name"              =>       "new_directory",
        "permissions"   =>       "0644"
      )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Create a directory.
my $mkdir = $cpliveapi->api2(
    'Fileman', 'mkdir',
      {
        "path"             =>       "/home/example/public_html",
        "name"          =>       "new_directory",
        "permissions"   =>       "0644"
      }
 );

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.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "mkdir",
    "data": [
      {
        "permissions": "0644",
        "name": "new_directory",
        "path": "/home/example/public_html"
      }
    ],
    "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
path	string	Required The new directory's path.	The absolute path to a location on the server.	/home/user/public_html/
name	string	Required The new directory's name.	A valid directory name.	new_directory
permissions	string	The new directory's file permissions.	A valid octal string.	0755

Returns

Return	Type	Description	Possible values	Example
`permissions`	string	The new directory's file permissions.	A valid octal string.	`0755`
`name`	string	The new directory's name.	A valid directory name.	new_directory
`path`	string	The new directory's path.	The absolute path to a location on the server.	/home/example/public_html
`reason`	string	A reason for failure Note: 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`

Knowledgebase

Categories

Categories