# cPanel API 2 Functions - Fileman::mkfile

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function creates a file.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

Important:
When you disable the [*File Storage* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


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

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

table
thead
tr
th
Parameter
th
Type
th
Description
th
Possible values
th
Example
tbody
tr
td
code
name
td
em
string
td
p
strong
Required
p
The new file's name.
td
A valid file name.
td
code
new_file.html
tr
td
p
code
path
td
em
string
td
p
strong
Required
p
The new file's path.
td
The absolute path to a location on the server.
td
code
/home/user/public_html/
tr
td
code
permissions
td
em
string
td
p
The new file's permissions.
p
This value defaults to 
code
0644
.
td
A valid octal string.
td
code
0755
## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
permissions
td
em
string
td
span
The new file's permissions.
td
span
A valid octal string.
td
code
0755
span
tr
td
code
name
td
em
string
td
span
The name of the new file.
td
p
A valid file name.
td
code
new_file
tr
td
code
path
td
em
string
td
span
The path to the new file.
td
A valid file path, relative to the user's home directory.
td
code
/home/example/public_html
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if an error occurred.
td
span
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1