Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB
Digital Asset Management (DAM)
Managing assets

Rename file

You can rename an already existing file in the media library using rename file API. This operation would rename all file versions of the file.

Note: The old URLs will stop working. The file/file version URLs cached on CDN will continue to work unless a purge is requested.

put/v1/files/rename

Request body

filePathstring required

The full path of the file you want to rename.

newFileNamestring required

The new name of the file. A filename can contain:

Alphanumeric Characters: a-z, A-Z, 0-9 (including Unicode letters, marks, and numerals in other languages). Special Characters: ., _, and -.

Any other character, including space, will be replaced by _.

purgeCacheboolean

Option to purge cache for the old file and its versions' URLs.

When set to true, it will internally issue a purge cache request on CDN to remove cached content of old file and its versions. This purge request is counted against your monthly purge quota.

Note: If the old file were accessible at https://ik.imagekit.io/demo/old-filename.jpg, a purge cache request would be issued against https://ik.imagekit.io/demo/old-filename.jpg* (with a wildcard at the end). It will remove the file and its versions' URLs and any transformations made using query parameters on this file or its versions. However, the cache for file transformations made using path parameters will persist. You can purge them using the purge API. For more details, refer to the purge API documentation.

Default value - false

Example request

{
  "filePath": "/path/to/file.jpg",
  "newFileName": "newFileName.jpg",
  "purgeCache": true
}

Response

On success, you will receive purgeRequestId in the response body, which can be used to get the purge request status. This is only sent if the purgeCache is set to true in the request. Otherwise, the response is an empty JSON.

purgeRequestIdstring

Unique identifier of the purge request. This can be used to check the status of the purge request.