Skip to content

Renaming a File/Directory

Method

PUT

URL

https://api.backendless.com/<application-id>/<REST-api-key>/files/rename

where:

Argument                Description
<application id> ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.

Request headers

Content-Type: application/json  
user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
Content-Type Must be set to application/json. This header is mandatory.
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. If user-token is set in the request, the currently logged in user will be assigned to the ownerId property of the user object which is being saved.  Additionally, the operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request Body:

A JSON object identifying a file or directory to be renamed and the new name:

{  
  "oldPathName" : current-name,  
  "newName": new-name  
}

where:

Argument                Description
current-name a path identifying file or directory to be renamed. The must start with the root directory for the file storage allocated to the application.
new-name new name for the file or directory.


Return value

Absolute path of the renamed file or directory.

Example

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

curl -H Content-Type: application/json -X PUT \   
-v https://api.backendless.com/XXXXX-XXXX-XXXX/ZZZZ-ZZZZ-ZZZZ/files/rename \  
-d "{ \"oldPathName\":\"/documentation/readme.txt\", \"newName\":\"readme-first.txt\" }"

Errors

When the backend reports an error, it returns a JSON object in the following format:

{  
  "message":error-message,  
  "code":error-code  
}

The server may return the following errors:

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

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