v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-214977372.7 KB

Digital Asset Management (DAM)

Managing folders

Rename folder

This API allows you to rename an existing folder. The folder and all its nested assets and sub-folders will remain unchanged, but their paths will be updated to reflect the new folder name.

post/v1/bulkJobs/renameFolder

Request body

folderPathstring required

The full path to the folder you want to rename.

newFolderNamestring required

The new name for the folder.

All characters except alphabets and numbers (inclusive of unicode letters, marks, and numerals in other languages) and - will be replaced by an underscore i.e. _.

purgeCacheboolean

Option to purge cache for the old nested files and their versions' URLs.

When set to true, it will internally issue a purge cache request on CDN to remove the cached content of the old nested files and their versions. There will only be one purge request for all the nested files, which will be counted against your monthly purge quota.

Note: A purge cache request will be issued against https://ik.imagekit.io/old/folder/path* (with a wildcard at the end). This will remove all nested files, their versions' URLs, and any transformations made using query parameters on these files or their 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

{
  "folderPath": "/path/of/folder",
  "newFolderName": "new-folder-name",
  "purgeCache": true
}

Response

jobIdstring required

Unique identifier of the bulk job. This can be used to check the status of the bulk job.