DeleteFolderRequest

Request body for DeleteFolder.

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

External storage: external files are only deleted when you directly delete a file or subfolder of a folder that has external storage configured. If you delete the folder itself, only the mapping is removed.

Structure

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

Example

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

Properties

deleteFiles Optional

If true then deletes files.

Default: true

Type: Boolean

deleteVirtualFolders Optional

If true then deletes virtual folders (virtual folders are folders created using the PutFolder operation).

Default: true

Type: Boolean

folderPath Required

The folder to delete.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

recursive Optional

If true then deletes files and folder settings that descend folderPath.

If false then only deletes files that are direct children of folderPath and only deletes the folder settings of the current folder (if any). Does not delete the folder settings of any child or descendant folders.

Default: true

Type: Boolean

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported:

UI Widgets

SDKs

Processing APIs

Core APIs

Data Types

More Resources

DeleteFolderRequest

Structure

Example

Properties

deleteFiles Optional

deleteVirtualFolders Optional

folderPath Required

recursive Optional

Used by

You are using an outdated browser.