Child pages
  • cPanel API 1 Functions - Fileman::fmmkdir

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function creates a new directory.


Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

  • UAPI (recommended)None.
  • cPanel API 2 Fileman::mkdir
    Excerpt Include
    DD:cPanel API 2 Functions - Fileman::mkdir
    DD:cPanel API 2 Functions - Fileman::mkdir
    nopaneltrue

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledFileStorageRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleLiveAPI PHP Class


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

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Fileman::fmmkdir ( $FORM('dir','file'))">



Expand
titleCommand Line


Code Block
cpapi1 --user=username Fileman fmmkdir public_html directory

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote


Expand
titleOutput (plaintext)


Code Block
languagetext
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.