Skip to main content

Update retention of all dependent copies for a WORM pool​

Select

SaaS
Customer Managed

API is used to update the retention of dependent copies of the storage pool. If the storage has object lock enabled, it will copy the retention of the storage pool and set it on all the dependent copies. If the storage has bucket lock enabled, it will copy the retention of maxRetentionStoragePoolId and set it on the pool and its depenedent copies.

Path Parameters
  • storagePoolId int32 required

    Id of storage pool

Query Parameters
  • maxRetentionStoragePoolId int32

    Id of the storage pool having max retention

Responses

OK

Schema
  • errorMessage string

    Tells about the error occured

  • errorCode ErrorCode

    Possible values: [NO_ERROR, INVALID_INPUT, VALUE_NOT_FOUND, UNKNOWN_EXCEPTION, CONNECTION_PROBLEM, UNKNOWN_SQL_ERROR, INVALID_USER, INVALID_OPERATION_TYPE, INTERNAL_SERVER_PROBLEM, INSUFFICIENT_USER_PERMISSION_ON_ENTITY, INVALID_ENTITY_ID, REFRESH_TOKEN_EXPIRED]

    Error code value

PUT /v4/storagepool/worm/:storagepoolid/retention

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
storagePoolId — path required
maxRetentionStoragePoolId — query
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/v4/StoragePool/WORM/:storagePoolId/Retention' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'