Bucket:Set Bucket Retention

Search (SHIFT+S)




New in this release

Set Bucket Retention

PUT /object/bucket/{bucketName}/retention

Updates the default retention period setting for the specified bucket.

bucketNameBucket name for which retention period will be updated.

Required Roles

  • SYSTEM_ADMIN


Prerequisites

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

  • Bucket name should not be null or empty.

  • Bucket must exist.


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<default_bucket_retention_update>
<period> Default retention period in seconds Long
<namespace> Namespace to which this bucket belongs String
</default_bucket_retention_update>

Response Body

Response indicating Success or Failure of the operation


Examples

Request
PUT https://192.168.0.0:4443/object/bucket/standalone-bucket/retention: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<default_bucket_retention_update>
   <period>3</period>
   <namespace>s3</namespace>
</default_bucket_retention_update>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Notes: