Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Update Retention Class

PUT /object/namespaces/namespace/{namespace}/retention/{class}

Updates the retention class details for a specified retention class for a namespace.

namespaceNamespace identifier for which retention class needs to retrieved.
classRetention class for which details needs to updated.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • NAMESPACE_ADMIN


Prerequisites

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

  • Namespace must exist


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
retention_class_update
period A new period value for class in seconds Long

Response Body

Response indicating Success or Failure to update retention class


Examples

Request
PUT https://192.168.0.0:4443/object/namespaces/namespace/s3/retention/c1

Content-Type: application/xml
X-SDS-AUTH-TOKEN=BAAcRGtUUmNOZHNpbitMaEVhZUhhdWtad1J3WDRRPQMAUAQADTEzNzk1NDIwMjQ4MzACAAEABQA5dXJuOnN0b3JhZ2VvczpUb2tlbjoxYmVhNGJiMy04M2MwLTRlOGItODc4Ni1iYWYxYmM4NTZkNTY6AgAC0A8=

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<retention_class_update>
    <period>2</period>
</retention_class_update>
Response
HTTP/1.1 200 OK
Content-Type: application/xml