DeleteFolderRequest

Request body for DeleteFolder.

You can use ListFolder to preview the operation using the dryRun parameter.

When deleting a folder with external storage: if the folder at folderPath has overridden storage settings (like an AWS S3 bucket), no files will be deleted, regardless of the parameters you pass. Only the mapping will be removed. If the folder at folderPath has inherited storage settings but includes subfolders with overridden storage settings, files in those subfolders won't be deleted, regardless of the parameters you pass. In summary, files in folders with overridden storage are never deleted, unless you directly delete a subfolder of such a folder.

{
  "deleteFiles": Boolean,
  "deleteVirtualFolders": Boolean,
  "folderPath": String,
  "recursive": Boolean
}

{
  "deleteFiles": true,
  "deleteVirtualFolders": true,
  "folderPath": "/uploads",
  "recursive": true
}

Was this section helpful? Yes No