Skip to content

Renaming a File/Directory

Blocking API

public string RenameFile( String oldPathName, String newName )

Non-Blocking API

public void RenameFile( String oldPathName, String newName, AsyncCallback<string> responder )


Argument                Description
oldPathName a path identifying file or directory to be renamed. The must start with the root directory for the file storage allocated to the application.
newName new name for the file or directory.
responder A responder object which receives a callback when the method successfully completes or if an error occurs. Applies to the asynchronous methods only.

Return value

Absolute path of the renamed file or directory.


The example below describes how to rename a file called readme.txt located in the /documentation directory to readme-first.txt:

Backendless.Files.RenameFile( "/documentation/readme.txt", "readme-first.txt" );


The server may return the following errors:

Error Code
Error message
User has no permissions to specified resource
Occurs when the user (anonymous or logged in) has no permission to modify the file
File or directory cannot be found.
Occurs when the source file/directory cannot be found.
Path contains prohibited symbols: {path name}

The specified resource was not found
Occurs when the API requests to rename a non-existent file or a directory.
Unable to modify file/folder: file/folder already exists: {file/directory name}
Occurs when the target file/directory already exists.
Parameter {param name} cannot be null
Occurs when one of the parameters is null.
Missing field {field name}
Occurs in REST APIs when one of the required fields is missing in the body.