Dell Technologies ECS REST API

Search (SHIFT+S)




Modified since last release

Deactivate Bucket

POST /object/bucket/{bucketName}/deactivate

Deletes the specified bucket.

bucketNameBucket name to be deleted

Query Parameters

namespaceNamespace associated. If it is null, then current user's namespace is used.
emptyBucketOptional: true | false (default). If emptyBucket=true the contents of the bucket will be emptied as part of the delete. The request will return a 202 Accepted if the bucket is not already empty and cleanup was initiated to run in the background.
The bucket will be read only during the operation. If the task successfully removes all related items the buket will be deleted. If the task is unable to remove all items or is aborted the bucket will be put back into a writable state.
Progress can be monitored through call to:
/object/bucket/{bucketName}/emtpy-bucket-status

If emptyBucket=false or not present the delete bucket operation will fail if the bucket is not empty.

Required Roles

  • SYSTEM_ADMIN


Prerequisites

The following conditions must be met in order to call this operation.

  • Only authenticated users can delete buckets

  • Bucket name should not be null or empty


Request Payload

No Request Payload


Response Body

Response indicating success, failure, or accepted (when emptyBucket == true) of the bucket delete operation.


Examples

Request
POST https://192.168.0.0:4443/object/bucket/bucket1/deactivate HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml