v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB
Buckets

Delete every object under a key prefix (folder) in a bucket

Soft-deletes every object on the specified branch whose key starts with prefix, in a single call. Intended to back a "delete folder" action in an object browser: a prefix of app/avatars/ removes every object beneath that folder. Served by the user's session (no customer S3 credentials required).

prefix must be non-empty, end with /, be at most 1024 bytes, and contain no control characters - a partial-segment prefix cannot accidentally delete sibling keys. Returns the number of objects soft-deleted (deleted), which may be 0 when no live object matched the prefix on this branch.

Only objects physically present on this branch are tombstoned; objects inherited from an ancestor branch via copy-on-write (not materialized on this branch) are out of scope.

Note: This endpoint is currently in Private Beta.

delete/projects/{project_id}/branches/{branch_id}/buckets/{bucket_name}/objects-by-prefix

Query parameters

prefixstring required

The key prefix (folder) to delete. Must be non-empty and end with /. Every object on this branch whose key starts with this prefix is soft-deleted.

Response

The prefix was soft-deleted. deleted is the number of objects tombstoned (may be 0 when nothing live matched on this branch).

deletedinteger required

The number of objects soft-deleted under the prefix. 0 when no live object matched the prefix on this branch.