Deletes a folder asynchronously.
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.
Requires a secret_* API key. Alternatively, you can use a public_* API key and JWT-based auth.
1curl "https://api.bytescale.com/v2/accounts/{accountId}/folders" \2 -X DELETE \3 -H "Authorization: Bearer YOUR_API_KEY" \4 -H "Content-Type: application/json" \5 -d @- << EOF6 {7 "deleteFiles": true,8 "deleteVirtualFolders": true,9 "folderPath": "/uploads",10 "recursive": true11 }12EOF1{2 "jobDocs": "https://www.bytescale.com/docs/job-api/GetJob",3 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",4 "jobType": "ExampleJob",5 "jobUrl": "https://api.bytescale.com/v2/accounts/FW25aki/jobs/ExampleJob/01ARZ3NDEKTSV4RRFFQ69G5FAV"6}Your account ID.
This is visible on the settings page:
https://www.bytescale.com/dashboard/settings
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:
https://www.bytescale.com/docs/auth
Note: this endpoint requires a secret_* API key.
Type: String
This endpoints requires a JSON request body.
Type: String
Value: "application/json"
This website uses cookies. By continuing you are consenting to the use of cookies per our Cookie Policy. Our legal policies were last updated August 16 2024.
This website requires a modern web browser -- the latest versions of these browsers are supported: