PUT v1/bunits/{bunitId}/pointbucketpresets/{pointBucketPresetId}?updateMethod={updateMethod}
Update a PoINT bucket preset.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the preset | integer |
Required |
pointBucketPresetId |
The ID of the preset to update | integer |
Required |
updateMethod |
When saving a preset all buckets with said preset will be updated to reflect the changes. If value is null an exception will be thrown if there are any buckets related to the preset. If value is true all buckets will have values locked by preset changed to new values except if value differs from previous value as this indicates it has been changed by an administrator. If value is false no changes will be made to related buckets |
UpdateMethod |
Default value is NotSet |
Body Parameters
The preset to update
PointBucketPreset| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
QualityGroup |
When creating a PoINT bucket only allow partitions with the given quality group |
QualityGroup |
None. |
LockQualityGroup |
boolean |
None. |
|
PartitionType |
When creating a PoINT bucket only allow partitions with the given storage class |
PointPartitionType |
None. |
LockPartitionType |
boolean |
None. |
|
ClientAccessEnabled |
Disable client access |
boolean |
None. |
LockClientAccessEnabled |
boolean |
None. |
|
RetentionPolicy |
Retention policy Can only be set to anything other than None if versioning state is enabled |
RetentionPolicy |
None. |
LockRetentionPolicy |
boolean |
None. |
|
RetentionDays |
Related to the chosen retention policy |
integer |
None. |
LockRetentionDays |
boolean |
None. |
|
AutoDestruction |
Available if retention policy is set to PAG |
boolean |
None. |
LockAutoDestruction |
boolean |
None. |
|
WriteProtected |
Enable write protection |
boolean |
None. |
LockWriteProtected |
boolean |
None. |
|
ReadPriority |
Object read priority |
Priority |
None. |
LockReadPriority |
boolean |
None. |
|
WritePriority |
Object write priority |
Priority |
None. |
LockWritePriority |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
LockVersioningState |
boolean |
None. |
|
MetadataCached |
Cache Custom Object Metadata |
boolean |
None. |
LockMetadataCached |
boolean |
None. |
|
ObjectCacheThresholdBytes |
Cache small objects Bytes 0, 512, 1024, 2048, 3072 or 4096 |
integer |
None. |
LockObjectCacheThresholdBytes |
boolean |
None. |
|
SosApiEnabled |
Enables support for Veeam SOSAPI |
boolean |
None. |
LockSosApiEnabled |
boolean |
None. |
|
AutoReplicationEnabled |
Creates a disk bucket which replicates itself to tape |
boolean |
None. |
LockAutoReplicationEnabled |
boolean |
None. |
|
Inherited |
Whether or not the bucket is related to the business unit currently given or one of it's ancestors |
boolean |
None. |
ObjectsSizeQuotaBytes |
Object Size Quota |
integer |
None. |
LockObjectsSizeQuotaBytes |
boolean |
None. |
|
BusinessUnit |
BusinessUnit |
None. |
|
BusinessUnitId |
integer |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The updated preset
PointBucketPreset| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
string |
None. |
|
QualityGroup |
When creating a PoINT bucket only allow partitions with the given quality group |
QualityGroup |
None. |
LockQualityGroup |
boolean |
None. |
|
PartitionType |
When creating a PoINT bucket only allow partitions with the given storage class |
PointPartitionType |
None. |
LockPartitionType |
boolean |
None. |
|
ClientAccessEnabled |
Disable client access |
boolean |
None. |
LockClientAccessEnabled |
boolean |
None. |
|
RetentionPolicy |
Retention policy Can only be set to anything other than None if versioning state is enabled |
RetentionPolicy |
None. |
LockRetentionPolicy |
boolean |
None. |
|
RetentionDays |
Related to the chosen retention policy |
integer |
None. |
LockRetentionDays |
boolean |
None. |
|
AutoDestruction |
Available if retention policy is set to PAG |
boolean |
None. |
LockAutoDestruction |
boolean |
None. |
|
WriteProtected |
Enable write protection |
boolean |
None. |
LockWriteProtected |
boolean |
None. |
|
ReadPriority |
Object read priority |
Priority |
None. |
LockReadPriority |
boolean |
None. |
|
WritePriority |
Object write priority |
Priority |
None. |
LockWritePriority |
boolean |
None. |
|
VersioningState |
Indicates whether S3 Versioning is Disabled, Enabled or Suspended. Once it is enabled, it cannot be disabled, but suspended - which effectively disables it for new objects, but keeps existing object versions. Thus, following transitions are allowed: Disabled > Enabled > Suspended > Enabled. |
VersioningState |
None. |
LockVersioningState |
boolean |
None. |
|
MetadataCached |
Cache Custom Object Metadata |
boolean |
None. |
LockMetadataCached |
boolean |
None. |
|
ObjectCacheThresholdBytes |
Cache small objects Bytes 0, 512, 1024, 2048, 3072 or 4096 |
integer |
None. |
LockObjectCacheThresholdBytes |
boolean |
None. |
|
SosApiEnabled |
Enables support for Veeam SOSAPI |
boolean |
None. |
LockSosApiEnabled |
boolean |
None. |
|
AutoReplicationEnabled |
Creates a disk bucket which replicates itself to tape |
boolean |
None. |
LockAutoReplicationEnabled |
boolean |
None. |
|
Inherited |
Whether or not the bucket is related to the business unit currently given or one of it's ancestors |
boolean |
None. |
ObjectsSizeQuotaBytes |
Object Size Quota |
integer |
None. |
LockObjectsSizeQuotaBytes |
boolean |
None. |
|
BusinessUnit |
BusinessUnit |
None. |
|
BusinessUnitId |
integer |
None. |
|
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.