You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • cPanel API 1 Functions - Fileman::fmpushfile
Skip to end of metadata
Go to start of metadata

Description

This function prints a file to the browser.

Warning:

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


Important:

In cPanel & WHM version 76 and later, when you disable the File Storage role, the system disables this function.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$print_file = $cpanel->api1('Fileman', 'fmmpushfile', array('public_html', 'myfile.html')); // Call the function.


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.
my $print_file = $cpliveapi->api1('Fileman', 'fmpushfile' ['public_html', 'myfile.html']); # Call the function.


Note:

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

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Fileman::fmmpushfile ( $FORM('dir','file'))">
 Command Line
cpapi1 --user=username Fileman fmpushfile public_html myfile.html


Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi1 command:

    /usr/local/cpanel/bin/cpapi1

 Output (plaintext)
( '&' => '&&', '<' => '&<', '>' => '&>', '"' => '&"', "'" => '&'' )

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

The file's directory.

This parameter defaults to the cPanel account's /home directory.

A valid directory name.public_html
filestring

Required

The file.

A valid file name.myfile.html

Returns

This function returns the file's contents with encoded, relevant HTML characters.