cPanel API 1 Functions - Fileman::fmmkfile - Knowledgebase

Description

This function creates a new blank file.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — Fileman::mkfile — This function creates a file.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$create_file = $cpanel->api1('Fileman', 'fmmkfile', array('public_html', 'myfile', 'pl') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $create_file = $cpliveapi->api1('Fileman', 'fmmkfile' ['public_html', 'myfile', 'pl']); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fmmkfile ( $FORM('dir','newfile','template'))">

Command Line

cpapi1 --user=username Fileman fmmkfile dir=public_html newfile=myfile template=pl

Notes:

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

Output (plaintext)

Creation of myfile.pl (Perl Script)succeeded.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	Required The new file's directory.	Any valid directory name on the server.	public_html
newfile	string	Required The new file's name.	A valid filename.	myfile
template	string	Required The new file's template.	.html .pl .sh .txt	.pl

Returns

This function returns a message of success that contains the new file's name.

Knowledgebase

Categories

Categories