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

Description

This function renames a file.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Important:

In cPanel & WHM version 76 and later, when you disable the FileStorage role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$rename_file = $cpanel->api1(Fileman, 'fmrename', array('public_html', 'myfile.txt', 'otherfile.txt', '1')); // 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 $rename_file = $cpliveapi->api1(Fileman, 'fmrename' ['public_html', 'myfile.txt', 'otherfile.txt', '1']); # 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::fmrename ( $FORM('dir','file','filename','doubledecode'))">
 Command Line
cpapi1 --user=username Fileman fmrename public_html myfile.txt otherfile.txt 1


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)
Renamed test.txt -> newname.txt

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The file's directory.

Any valid directory name.public_html
filestring

Required

The file to rename.

Any valid file name.myfile.txt
filenewstring

Required

The file's new name.

The file's new name.newfile
doubledecodeBoolean

Required

Whether to decode the dir and file parameters' URI values.

  • 0 – Do not decode.
  • 1 – Decode.
1

Returns

This function returns a message of success with the file's old and new name.