PUT v1/bunits/{bunitId}/consumers/{consumerId}/pointbucket
Update the information of a bucket
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
The ID of the business unit of the bucket | integer |
Required |
consumerId |
The ID of the consumption unit of the bucket | integer |
Required |
Body Parameters
The bucket containing the updated information
PointBucket| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
Name |
string |
None. |
PointId |
Unique PoINT ID |
string |
None. |
ClientAccessEnabled |
Disable client access |
boolean |
None. |
RetentionPolicy |
Retention policy of bucket. Versioning state must be enabled to select anything other than NONE None = 0 S3NoDefault = 1 S3Governance = 2 - Not implmented S3Compliance = 3 - Not implmented PAG = 4 - Not implmented |
RetentionPolicy |
None. |
RetentionDays |
Related to the chosen retention policy |
integer |
None. |
AutoDestruction |
Available if retention policy is set to PAG |
boolean |
None. |
WriteProtected |
Enable write protection |
boolean |
None. |
ReadPriority |
Object read priority |
Priority |
None. |
WritePriority |
Object write priority |
Priority |
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. |
MetadataCached |
Cache Custom Object Metadata |
boolean |
None. |
ObjectCacheThresholdBytes |
Cache small objects Bytes 0, 512, 1024, 2048, 3072 or 4096 |
integer |
None. |
SosApiEnabled |
Enables support for Veeam SOSAPI |
boolean |
None. |
AutoReplicationEnabled |
Creates a disk bucket which replicates itself to tape |
boolean |
None. |
ObjectCount |
Number of Objects |
integer |
None. |
ObjectsSizeBytes |
Total Size of Objects |
integer |
None. |
ObjectsSizeQuotaBytes |
Object Size Quota |
integer |
None. |
Preset |
PointBucketPreset |
None. |
|
DeleteProcess |
DeleteProcess |
None. |
|
Owner |
PointUser |
None. |
|
Partition |
PointPartition |
None. |
|
Consumer |
Consumer |
None. |
|
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
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 bucket
PointBucket| Name | Description | Type | Additional information |
|---|---|---|---|
Name |
Name |
string |
None. |
PointId |
Unique PoINT ID |
string |
None. |
ClientAccessEnabled |
Disable client access |
boolean |
None. |
RetentionPolicy |
Retention policy of bucket. Versioning state must be enabled to select anything other than NONE None = 0 S3NoDefault = 1 S3Governance = 2 - Not implmented S3Compliance = 3 - Not implmented PAG = 4 - Not implmented |
RetentionPolicy |
None. |
RetentionDays |
Related to the chosen retention policy |
integer |
None. |
AutoDestruction |
Available if retention policy is set to PAG |
boolean |
None. |
WriteProtected |
Enable write protection |
boolean |
None. |
ReadPriority |
Object read priority |
Priority |
None. |
WritePriority |
Object write priority |
Priority |
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. |
MetadataCached |
Cache Custom Object Metadata |
boolean |
None. |
ObjectCacheThresholdBytes |
Cache small objects Bytes 0, 512, 1024, 2048, 3072 or 4096 |
integer |
None. |
SosApiEnabled |
Enables support for Veeam SOSAPI |
boolean |
None. |
AutoReplicationEnabled |
Creates a disk bucket which replicates itself to tape |
boolean |
None. |
ObjectCount |
Number of Objects |
integer |
None. |
ObjectsSizeBytes |
Total Size of Objects |
integer |
None. |
ObjectsSizeQuotaBytes |
Object Size Quota |
integer |
None. |
Preset |
PointBucketPreset |
None. |
|
DeleteProcess |
DeleteProcess |
None. |
|
Owner |
PointUser |
None. |
|
Partition |
PointPartition |
None. |
|
Consumer |
Consumer |
None. |
|
DataSourceState |
DataSourceState |
None. |
|
DataSourcePlatform |
DataSourcePlatform |
None. |
|
DataSourceType |
DataSourceType |
None. |
|
BackupServer |
Server |
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.