cPanel API 2 Functions - Fileman::mkfile

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

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.

Important:

When you disable the File Storage role, the system disables this function.

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

Note:

For more information, read our Calls from the WHM API documentation.

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

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.

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

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

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.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

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 (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter Type Description Possible values Example

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 to `0644`.	A valid octal string.	`0755`

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 to 0644.

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 home directory.	`/home/example/public_html`
`reason`	string	A reason for failure. 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`