Description

This function creates a directory.

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=mkdir&path=public_html&name=new_directory



$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" 
      )
);

 



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" 
      }
 );

 




cpapi2 --user=username Fileman mkdir path=%2Fhome%2Fexample%2Fpublic_html name=new_directory permissions=0644



{
  "cpanelresult": {
    "apiversion": 2,
    "func": "mkdir",
    "data": [
      {
        "permissions": "0644",
        "name": "new_directory",
        "path": "/home/example/public_html"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}



Parameters

ParameterTypeDescriptionPossible valuesExample

path

string

Required

The new directory's path.

The absolute path to a location on the server./home/user/public_html/
namestring

Required

The new directory's name.

A valid directory name.new_directory
permissionsstringThe new directory's file permissions.A valid octal string.0755

Returns

ReturnTypeDescriptionPossible valuesExample
permissionsstringThe new directory's file permissions.A valid octal string.0755  
namestring

The new directory's name.

A valid directory name.

new_directory
pathstringThe new directory's path.The absolute path to a location on the server.
/home/example/public_html
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