Child pages
  • cPanel API 1 Functions - Fileman::fmmkdir
Skip to end of metadata
Go to start of metadata

Description

This function creates a new directory.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Important:

In cPanel & WHM version 76 and later, when you disable the FileStorage role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$create_directory = $cpanel->api1('Fileman', 'fmmkdir', array('public_html', 'directory')); // Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $create_directory = $cpliveapi->api1('Fileman', 'fmmkdir' ['public_html', 'directory']); # Call the function.


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fmmkdir ( $FORM('dir','file'))">
 Command Line
cpapi1 --user=username Fileman fmmkdir public_html directory


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
Created /home/USER/DIRECTORY

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The new directory's parent directory.

Any valid directory name on the server.public_html
filestring

Required

The new directory name.

Any valid directory name.directory

 Returns

This function returns a message of success with the new directory's path from the /home directory.