DeleteFolderBatch

Deletes multiple folders asynchronously.

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.

1curl "https://api.upload.io/v2/accounts/{accountId}/folders/batch" \
2     -X DELETE \
3     -H "Authorization: Bearer YOUR_API_KEY" \
4     -H "Content-Type: application/json" \
5     -d @- << EOF
6     {
7       "folders": [
8         {
9           "deleteFiles": true,
10           "deleteVirtualFolders": true,
11           "folderPath": "/uploads",
12           "recursive": true
13         }
14       ]
15     }
16EOF

1{
2  "jobDocs": "https://upload.io/docs/upload-api/jobs/GetJob",
3  "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
4  "jobType": "ExampleJob",
5  "jobUrl": "https://api.upload.io/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV"
6}

Request Body

See full details

Response Body

See full details

URL Parameters

accountId

Your account ID.

This is visible on the settings page:

https://upload.io/dashboard/settings

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes

Request Headers

Authorization

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, specifying apikey as your username, and your API key as your password.

Type: String

In: Header

Required: Yes

Content-Type

This endpoints requires a JSON request body.

Type: String

Value: "application/json"

In: Header

Required: Yes

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:

File Uploading

File Processing APIs

Data Types

More Resources

DeleteFolderBatch

Request Body

Response Body

URL Parameters

accountId

Request Headers

Authorization

Content-Type

You are using an outdated browser.