s3.bucket-objects.empty

Empty the bucket in the background: every object, version and delete marker, for good

POST /s3/api/buckets/{name}/emptyIAM s3:DeleteObjectVersionChanges stateDestructive

Answers 202 with the job ({ id, status, total, deleted, failed, errors, remaining, perSecond, … }), or 200 with the one already running. total: what the bucket held when it started (counted first); when it finishes, deleted is total less remaining. Each version is still checked against your policies and the bucket policy; what they keep is counted in failed and stays. Follow it with empty-status; the bucket and its settings stay.

Request syntax

POST /s3/api/buckets/{name}/empty

Path parameters

  • nameRequired

    string

    Constraints: 3-63 chars, /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Response

202 with the new empty job, or 200 with the one already running; data is the job: id, status, total, deleted, failed, errors, remaining, perSecond, lastError and its timestamps.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow s3:DeleteObjectVersion on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud s3 bucket-objects empty name

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_bucket-objects_empty.