DeleteFolderRequest

Request body for DeleteFolder.

If the folder has overridden storage settings, then no files will be deleted.

You can use ListFolder to preview the operation: set dryRun=true with recursive, includeFiles and includeVirtualFolders set to match the values you're using here. Leave all other flags unset.

Structure

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

Example

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

Properties

deleteFiles

If true then deletes files.

Default: true

Type: Boolean

Required: No

deleteVirtualFolders

If true then deletes folder settings.

Default: true

Type: Boolean

Required: No

folderPath

The folder to delete.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

Required: Yes

recursive

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

Required: No

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

deleteVirtualFolders

folderPath

recursive

Used by

You are using an outdated browser.