cPanel API 2 Functions - Fileman::mkfile - Knowledgebase

Description

This function creates a file.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

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

 LiveAPI PHP Class

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

 LiveAPI Perl Module

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

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that youonly use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

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

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

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

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
name	string	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/
permissions	string	The new file's permissions. This value defaults to0644.	A valid octal string.	0755

Returns

Return	Type	Description	Possible values	Example
permissions	string	The new file's permissions.	A valid octal string.	0755
name	string	The name of the new file.	A valid file name.	new_file
path	string	The path to the new file.	A valid file path, relative to the user's homedirectory.	/home/example/public_html
reason	string	A reason for failure. Note: This function only returns a reason value if an error occurred.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories