cPanel API 1 Functions - Fileman::getfile - Knowledgebase

Description

This function prints the contents of a file to the web browser.

Warning:

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

UAPI (recommended) — Fileman::get_file_content — This function retrieves a file's content.
cPanel API 2 — None.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$print_file_contents = $cpanel->api1('Fileman', 'getfile', array('public_html','myfile.txt')); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $print_file_contents = $cpliveapi->api1('Fileman', 'getfile' ['public_html', 'myfile.txt']); # 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::getfile ( $FORM('dir','file'))">

Command Line

cpapi1 --user=username Fileman getfile dir=public_html file=myfile.txt

Notes:

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

Output

These are the contents of the file.

Parameters

Parameter	Type	Description	Possible values	Example
dir	string	The file's directory. This value defaults to the user's/home directory.	Any valid directory, relative to the cPanel account's /home directory.	public_html
file	string	Required The file to display.	Any valid file name.	myfile.txt

Parameter

Type

Description

Possible values

Example

dir

string

The file's directory.

This value defaults to the user's/home directory.

Any valid directory, relative to the cPanel account's /home directory.

public_html

file

string

Required

The file to display.

Any valid file name.

myfile.txt

Returns

This function returns the file's contents.

Knowledgebase

Categories

Categories