Data Types


Deletes a folder asynchronously.

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.

Requires a secret_* API key. Alternatively, you can use a public_* API key and JWT-based auth.

DELETE /v2/accounts/{accountId}/folders
1curl "{accountId}/folders" \
3 -H "Authorization: Bearer YOUR_API_KEY" \
4 -H "Content-Type: application/json" \
5 -d @- << EOF
6 {
7 "deleteFiles": true,
8 "deleteVirtualFolders": true,
9 "folderPath": "/uploads",
10 "recursive": true
11 }
Response (200)
2 "jobDocs": "",
3 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
4 "jobType": "ExampleJob",
5 "jobUrl": ""

Your account ID.

This is visible on the settings page:

Example: "A623uY2"

Type: String

Length: 7

Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization with apikey as your username and your API key as your password.

For advanced options, please see:

Note: this endpoint requires a secret_* API key.

Type: String

This endpoints requires a JSON request body.

Type: String

Value: "application/json"

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: