Edit storage pool object expiration

Edit online

Edit object expiration settings for a storage pool.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit Storage Pool Object Expiration API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online
POST /manager/api/{apiResponseType}/1.0/editStoragePoolObjectExpiration.adm HTTP/1.1 Host:{manager.dsnet}
id={storage-pool-id}&objectExpiration={disabled|enabledAllVaults|enabledSpecificVaults}&vaults[vault-id]={enabled|disabled}

POST /manager/api/{apiResponseType}/1.0/editStoragePoolObjectExpiration.adm HTTP/1.1 Host:{manager.dsnet}
id={storage-pool-id}&objectExpirationEnabled={true|false}

Curl method

Edit online
curl -u {admin}:{password}
-k "https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editStoragePoolObjectExpiration.adm"
-d "id={storage-pool-id}&objectExpiration={disabled|enabledAllVaults|enabledSpecificVaults}&vaults[vault-id]={enabled|disabled}"
curl -u {admin}:{password}
-k "https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editStoragePoolObjectExpiration.adm"
-d "id={storage-pool-id}&objectExpirationEnabled={true|false}"

Parameters

Edit online
Table 2. Request Parameters for Edit Storage Pool Object Expiration (editStoragePoolObjectExpiration) API method
Parameter Type Usage Default Description
id Long Required  

Manager-generated ID of a storage pool.
objectExpiration String Required disabled

Configure object expiration.
vaults Map Optional  

A map of vault IDs to flag, where the flag represents if object expiration is enabled or disabled on the vault.
objectExpirationEnabled Boolean Optional False