Namespace:Create Retention Class

Search (SHIFT+S)




New in this release

Create Retention Class

POST /object/namespaces/namespace/{namespace}/retention

Creates a retention class for the specified namespace. The method payload specifies the retention class details which define a name for the class and a retention period.

namespaceNamespace identifier for which retention class needs to created.

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_create>
<name> Name of the retention class String
<period> Period of the retention class in seconds Long
</retention_class_create>

Response Body

Response indicating Success or Failure to create retention class


Examples

Request
POST https://192.168.0.0:4443/object/namespaces/namespace/s3/retention HTTP/1.1

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

<retention_class_create>
   <name>retcls3</name>
   <period>4</period>
</retention_class_create>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Notes: