Rename Object

Description

This API allows you to rename the required object stored in a bucket. The Bucket is referred by its unique bucket name, and the required object is referred using its name.

Note: 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.

Request Details

Request URL

PATCH

{api-domain}/baas/v1/project/{project_id}/bucket/object

copy

project_id

Numerical

The unique ID of the project

Query Parameters

bucket_name Alphanumeric

mandatory

The name of the bucket

current_key String

mandatory

Will contain the complete name of the required object.

rename_to String

mandatory

Will contain the new name of the object.

Request Headers

Authorization: Zoho-oauthtoken {oauth_token}

Optional Headers

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.buckets.objects.UPDATE

Response Details

On successful execution, the response will contain the previous name, modified name, and the success message confirming the rename action.

Sample Request
copy

curl -X PATCH https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/?bucket_name=myBucketName¤t_key=image2.png&rename_to=renamed.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

Sample Response
copy
{
"status": "success",
"data": {
    "current_key": "image2.png",
    "rename_to": "renamed.png",
    "message": "Rename successful"
}
}

View more

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit