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

Description

This function moves or copies a file to a different directory.

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 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.
$move_file = $cpanel->api1('Fileman', 'dofileop', array('public_html', 'myfile.txt', 'user2', 'move')); // 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 $move_file = $cpliveapi->api1('Fileman', 'dofileop' ['public_html', 'myfile.txt', 'user2', 'move']); # 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::dofileop ( $FORM('opdir','opfile','dir','fileop'))">
 Command Line
cpapi1 --user=username Fileman dofileop public_html myfile.txt user2 move


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 (none)

This functions does not return any output.

Parameters

ParameterTypeDescriptionPossible valuesExample
opdirstring

The file's directory.

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

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

Required

The file to move or copy.

Any valid filename.myfile.txt
dirstring

Required

The file's new location.

Any valid directory.user2
fileopstring

Required

The operation to perform.

  • copy
  • move
move

Returns

This function does not return output.