Rename and Move Operations on an Object

To rename and to move an object, we will be using the same renameObject() SDK method. The Bucket reference used in the below code snippet is the component instance.

Info: To use this SDK method, you need intialize it with Admin scope. You can learn more about this requirement from this section

Parameters Used

Parameter Name Data Type Definition
key String The original name of the object that you need to rename
destination String The new name that you rename the object with
Note:
  • You need to provide the complete object name, along with the path for both key and destination values.

  • For example, if you have file named “kitten.png” in the path pictures/puppy, and you need to rename or move the file to pictures/kitten path, then:

key value will be ‘pictures/puppy/kitten.png

destination value will be ‘pictures/kitten/kitten.png


Rename an Object

Using the renameObject() SDK method you can rename objects present in a bucket.

Info: To use this SDK method, you need intialize it with Admin scope. You can learn more about this requirement from this section
Note:
  • You cannot rename objects in a bucket that has Versioning enabled.

  • The following characters including space are not supported when you create a path or an object: double quote, both angular brackets, hashtag, backward slash and pipe symbol.

    
copy
const res = await bucket.renameObject("sam/out/sample.txt", "sam/out/update_sample.txt"); console.log(res);

Move an Object

Using the renameObject() SDK method, we can move the object from one path to another within a bucket.

    
copy
const moveRes = await bucket.renameObject("sam/out/sample.txt", "out/sample.txt"); console.log(moveRes);
Note: You cannot perform move operations in a bucket that has Versioning enabled.

Example Response for Rename and Move Operations

    
copy
{ "current_key": "sam/out/sample.txt", "message": "Rename successful", "rename_to": "sam/out/update_sample.txt" }

Last Updated 2025-05-30 16:54:59 +0530 +0530