Rename assets

The public ID of a renamed media asset is immediately and permanently updated in your cloud storage with the rename method of the API. Any existing URLs of renamed assets and their associated derived assets are no longer valid, but assets and transformed assets already downloaded by visitors of your website might still be accessible for a certain period of time through cached copies on the CDN.

You can set the invalidate parameter to true while renaming an asset in order to also invalidate the cached copies of the asset on the CDN. It usually takes between a few seconds and a few minutes for the invalidation to fully propagate through the CDN. There are also a number of other important considerations when using the invalidate functionality.

For example, renaming an image with the public ID of old_name to new_name:

For complete details on all available options, see the rename method.

Bulk rename existing assets

To rename a large set of existing assets, combine the Admin API to list assets with the rename method called on each one in a loop.

The examples below retrieve all assets with a given tag, strip a _upload suffix from each public ID, and rename them. The loop handles pagination automatically using next_cursor.

To list assets by folder prefix instead of tag, replace the resources_by_tag call with resources and pass a prefix parameter: