Data Types


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.


"deleteFiles": Boolean,
"folderPath": String,
"recursive": Boolean


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



If true then deletes files.

Default: true

Type: Boolean

Required: No


If true then deletes all virtual folder settings at the current path and below.

Virtual folders are folders that have been created using the PutFolder operation.

Default: true

Type: Boolean

Required: No


The folder to delete.

Example: "/uploads"

Type: String

Min Length: 1

Max Length: 512

Required: Yes


If true then deletes files and virtual folders that are descendants of folderPath.

If false then only deletes files that are direct children of folderPath, and does not delete descendant virtual folders (children or otherwise).

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: