Edit a vault

Edit online

Edits an existing vault. Many of the same values from the createVault method are supported by using this API. A vault cannot be moved to a new storage pool. SecureSlice and Analytics settings cannot be modified after vault creation.

Request

Edit online

Security

Edit online
-->
Table 1. Roles capable of executing the Edit Vault API method
Any     Storage Account Admin  
Super User ✔   Container Admin  
System Admin ✔   Elastic Device Provisioner  
Security Admin     Vault Provisioner  
Operator        

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editVault.adm HTTP/1.1 Host:{manager.dsnet} id={vaultId}&description={description}&objectExpirationEnabled{true|false}

Curl method

Edit online

curl -u {admin}:{password}

-k "https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editVault.adm"

-d "id={vaultId}&description={description}&objectExpirationEnabled{true|false}"

Parameters

Edit online
Table 2. Request Parameters for Edit Vault (editVault) API method
Parameter Type Usage Default Description
id Long Required  

ID of vault to edit. This ID is returned after vault creation.
name String Optional  

Unique name for new vault. Manager node uses this name for all references to this vault. Names can include underscores and alphanumeric characters.
description String Optional  

Description of vault. It is informational only.
writeThreshold Int Optional  

Write threshold.
privacyEnabled Boolean Optional Vault's existing privacyEnabled setting.

Enable (true) or disable (false) SecureSlice™ for this vault template. If not provided, value defaults to the system level SecureSlice™ configuration.
privacyAlgorithm String Optional Vault's existing privacyAlgorithm setting.

Valid privacy algorithms are aont-aes-gcm-256, aont-rc4-128, aont-aes-128, or aont-aes-256. If not provided, value defaults to the system level SecureSlice™ configuration.
alertLevel Int Optional  If alertLevel is not set or the difference between vaultWidth and writeThreshold is less than two, then there are no alerts.

Otherwise, alertLevel = writeThreshold + 2

Number of running Slicestor® Devices for vault to be considered working. Must be >= writeThreshold and < vaultWidth.
softQuotaSize BigDecimal Optional  

Size of soft quota.
softQuotaUnit String softQuotaSize=true  

Unit of measure for soft quota. For example: bytes, kB, MB, KiB, MiB, etc.
hardQuotaSize BigDecimal Optional  

Size of hard quota.
hardQuotaUnit String hardQuotaSize=true  

Unit of measure for hard quota. For example: bytes, kB, MB, KiB, MiB, etc.
versioning String Optional false enabled, disabled, or suspended inversion.
Note: For container vaults, only the values enabled and disabled are allowed. These values correspond with 'allowing' or 'not allowing' container versioning.
deleteRestricted Boolean Optional false

Prevent (true) or allow (false) deletes on the vault.

  • If enabled, versioning is set to true.
  • If not given, previous state is retained.
provisioningCode String Optional  

During container creation, the provisioning code is specified (as part of the locationConstraint) to indicate in which container vault the container should be created. If the provisioning code is not set, containers can be created in this container vault if this container vault is configured as the default container vault for an access pool.
region String Optional   Available for container vaults only. It indicates where the contents of this vault resides.
storageClass String Optional   Available for container vaults only. It is a classification assigned to all objects stored within this vault.
nameIndexEnabled Boolean Optional  

Enable (true) or disable (false) name index on vault. It cannot be enabled on 1-wide vault.
recoveryListingEnabled Boolean Optional false

Enable (true) or disable (false) Recovery Listing.
tagMap String Optional  

add or remove the tag.
tags String Optional   Takes a Set of tag names. 
ssecEnabled Boolean True/False   Turn on SSE-C (Server-Side Encryption with Customer provided keys) for the vault.
Note: When enabled, SSE-C cannot be disabled on a vault.
protectionState String Optional disabled Possible values are–disabled, or enabled.
Note: To support backwards compatibility with ClevOS 3.12.0, this request accepts the value Compliance for the Status parameter in addition to Retention. The protection state Retention and Compliance are used interchangeably.
minimumRetentionPeriod Long Optional 0 days Accepts value in days. Minimum value should be ≥ 0 days.

This parameter is only valid if protection state is set to enabled.

Note: This is for vault mode only.
maximumRetentionPeriod Long Optional 36159 days Accepts value in days. Maximum value should be ≤ 2,147,483,647 days.

This parameter is only valid if protection state is set to enabled.

Note: This is for vault mode only.
defaultRetentionPeriod Long Optional 730 days Accepts value in days. The default must be ≥mininumumRetentionPeriod and ≤maximumRetentionPeriod retention period.

This parameter is only valid if protection state is set to enabled.

Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both.

Note: This is for vault mode only.
ssekpEnabled Boolean Optional false Turn on SSE-KP (server side encryption with Key Protect managed keys) for the vault.

Once enabled, SSE-KP cannot be disabled on a vault.

Note: This is a cloud-only feature.
Note: Not supported for management vaults, service vaults, or standard vaults.
notificationServiceTopicOverride String Optional   The topic to use instead of the default topic of an associated IBM Cloud Object Storage Notification Service
notificationServiceId Long Optional   The ID of the IBM Cloud Object Storage Notification Service to associate with this vault
permanentRetentionEnabled Boolean Optional false This allows objects to have permanent retention.

This parameter is only valid if protection state is set to enabled.

Note: This is vault mode only.
defaultPermanentRetentionDurationEnabled Boolean Optional false

When set to true, objects written into this vault without a specific retention period will have permanent retention.

This parameter is only valid if protection state is set to enabled.

Either defaultRetentionPeriod or defaultPermanentRetentionDurationEnabled should be specified, but not both.

Note: This is vault mode only.
powerSafeWriteEnabled Boolean     Enable Power Safe Write for the vault.
notificationServiceTopicDelegated Boolean Optional   Delegate the configuration of the Notification Service topic.
organizationId Long Optional   The ID of the organization for the vault.
objectExpirationEnabled Boolean Optional False Enables object expiration.
staticWebsiteHostingEnabled

Boolean

Optional

 false
Enables Static Website Hosting on the vault.
  • Vaults must have DNS-compliant names.
  • Static Website Virtual Host Suffix must be configured on the access pool(s) to which this vault will be deployed.
containerVaultObjectLockEnabled Boolean Optional Storage pool containerVaultObjectLockEnabled value Enable container vault object lock on the vault. When this setting is not specified then it will inherit the Storage Pool's Object Lock setting value.
replicationEnabled Boolean Optional Storage pool replicationEnabled value Enables replication for this vault, allowing users to configure replication for buckets contained within this vault. Also enables/disables background replication processing for any source buckets contained within this vault.
replicationEndpoint Boolean Optional   Specifies endpoint to be used for any replications targeted to destination buckets within this vault. May provide a raw IP address or a DNS-compliant hostname. Scheme / port are not allowed; replication requires HTTPS, and the S3 API to be reachable via the default HTTPS port (443) on that endpoint.
replicationSyncLatencyThreshold Integer Optional 1 hour Replication sync latency threshold, specified in seconds. If replications take longer than this duration, events will be logged in the Event Console. In other words, this specifies the duration in which individual object replications are generally expected to occur.

When not provided, previous values are retained.