Child pages
  • cPanel API 2 Functions - Fileman::mkfile

Versions Compared

Key

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

Description

Excerpt
This function creates a file.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

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
titleWHM API (JSON)


Code Block
languagetext
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Fileman&cpanel_jsonapi_func=mkfile&name=new_file&path=public_html&permissions=0700

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Create a file.
$mkdir = $cpanel->api2(
    'Fileman', 'mkdir', 
		array(
        "name"		 	=> 		"new_file",
		"path"		  	=> 		"/home/example/public_html",
		"permissions"	=> 		"0700" 
      )
);

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.
 
# Create a file.
my $mkfile = $cpliveapi->api2(
    'Fileman', 'mkfile',
      {
        "name"		 	=> 		"new_file",
		"path"	    	=> 		"/home/example/public_html",
		"permissions"	=> 		"0700" 
      }
 );

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username Fileman mkfile name=new_file path=%2Fhome%2Fexample%2Fpublic_html permissions=0700

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "mkfile",
    "data": [
      {
        "permissions": "0700",
        "name": "new_file.html",
        "path": "/home/example"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Fileman"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
namestring

Required

The new file's name.

A valid file name.new_file.html

path

string

Required

The new file's path.

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

The new file's permissions.

This value defaults to 0644.

A valid octal string.0755

Returns

ReturnTypeDescriptionPossible valuesExample
permissionsstringThe new file's permissions.A valid octal string.0755  
namestringThe name of the new file.

A valid file name.

new_file
pathstringThe path to the new file.A valid file path, relative to the user's home directory .
/home/example/public_html
reasonstring

A reason for failure.

Note
titleNote:

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