Assets

Updates an existing asset's identifier (public ID) and optionally other metadata in your Cloudinary account

POST
/v1_1/{cloud_name}/{resource_type}/rename

Authorization

AuthorizationBasic <token>

Basic authentication using Cloudinary API Key and API Secret.

In: header

Path Parameters

cloud_name*string

The cloud name of your product environment.

resource_type*string

The type of resource (image, video, or raw).

Value in

  • "image"
  • "video"
  • "raw"

Request Body

application/json

The rename request parameters.

The rename request parameters.

api_key?string

The API key to use for the request. This is automatically computed by the Cloudinary's SDKs.

timestamp?integer

The timestamp to use for the request in unix time. This is automatically computed by the Cloudinary's SDKs.

Formatint64
signature?string

(Required for signed REST API calls) Used to authenticate the request and based on the parameters you use in the request. When using the Cloudinary SDKs for signed requests, the signature is automatically generated and added to the request. If you manually generate your own signed POST request, you need to manually generate the signature parameter and add it to the request together with the api_key and timestamp parameters.

from_public_id*string

The public ID of the asset to rename.

to_public_id*string

The new public ID for the asset.

type?|

Delivery types accepted by upload and rename operations.

to_type?|

Delivery types accepted by upload and rename operations.

overwrite?boolean

Whether to overwrite the target asset if it already exists. Default is false.

Defaultfalse
invalidate?boolean

Whether to invalidate CDN cache copies of the renamed asset. Default is false.

Defaultfalse
context?boolean

Whether to include contextual metadata in the response. Default is false.

Defaultfalse
metadata?boolean

Whether to include structured metadata in the response. Default is false.

Defaultfalse
notification_url?string

URL to notify when the operation is complete.

Formaturi

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1_1/my_cloud/image/rename" \  -H "Content-Type: application/json" \  -d '{    "from_public_id": "string",    "to_public_id": "string"  }'
{  "url": "http://example.com",  "secure_url": "http://example.com",  "public_id": "string",  "version": 0,  "version_id": "string",  "signature": "string",  "width": 0,  "height": 0,  "asset_id": "string",  "format": "string",  "resource_type": "string",  "created_at": "2019-08-24T14:15:22Z",  "tags": [    "string"  ],  "context": {    "custom": {      "property1": "string",      "property2": "string"    },    "property1": {      "property1": "string",      "property2": "string"    },    "property2": {      "property1": "string",      "property2": "string"    }  },  "metadata": {},  "pages": 0,  "bytes": 0,  "type": "string",  "etag": "string",  "placeholder": true,  "original_filename": "string",  "image_metadata": {},  "illustration_score": 0,  "semi_transparent": true,  "grayscale": true,  "faces": [    [      0    ]  ],  "coordinates": {    "faces": [      [        0      ]    ],    "custom": [      [        0      ]    ]  },  "eager": [    {      "transformation": "string",      "width": 0,      "height": 0,      "bytes": 0,      "format": "string",      "url": "string",      "secure_url": "string"    }  ],  "asset_folder": "string",  "display_name": "string",  "api_key": "string"}