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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »


This function creates a new directory.


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

  • UAPI (recommended)None.
  • cPanel API 2Fileman::mkdir
    Error rendering macro 'excerpt-include' : No link could be created for 'cPanel API 2 Functions - Fileman::mkdir'.


 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.


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.


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

 cPanel Tag System (deprecated)


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


  • 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:


 Output (plaintext)
Created /home/USER/DIRECTORY


ParameterTypeDescriptionPossible valuesExample


The new directory's parent directory.

Any valid directory name on the server.public_html


The new directory name.

Any valid directory


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




  • No labels