Buckets: update

Updates the metadata of a bucket. Changes to the bucket are readable immediately after writing, but configuration changes may take time to propagate.

Required permissions

To use this method,the authenticated user must have the storage.buckets.update IAM permission. Additionally, to perform specific actions on a bucket, the authenticated user must have the following permissions:

  • To update public access prevention policies or access control lists (ACLs): storage.buckets.setIamPolicy
  • To return ACLs on a bucket: storage.buckets.getIamPolicy
  • To update bucket IP filtering rules: storage.buckets.setIpFilter
  • To return bucket IP filtering rules as part of the response: storage.buckets.getIpFilter

Request

HTTP request

PUT https://storage.googleapis.com/storage/v1/b/bucket

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.

Parameters

Parameter name Value Description
Path parameters
bucket string Name of a bucket.
Optional query parameters
ifMetagenerationMatch long Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
ifMetagenerationNotMatch long Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
predefinedAcl string Apply a predefined set of access controls to this bucket.

Acceptable values are:
  • authenticatedRead: Project team owners get OWNER access, and allAuthenticatedUsers get READER access.
  • private: Project team owners get OWNER access.
  • projectPrivate: Project team members get access according to their roles.
  • publicRead: Project team owners get OWNER access, and allUsers get READER access.
  • publicReadWrite: Project team owners get OWNER access, and allUsers get WRITER access.
If iamConfiguration.uniformBucketLevelAccess.enabled is set to true, requests that include this parameter fail with a 400 Bad Request response.
predefinedDefaultObjectAcl string Apply a predefined set of default object access controls to this bucket.

Acceptable values are:
  • authenticatedRead: Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
  • bucketOwnerFullControl: Object owner gets OWNER access, and project team owners get OWNER access.
  • bucketOwnerRead: Object owner gets OWNER access, and project team owners get READER access.
  • private: Object owner gets OWNER access.
  • projectPrivate: Object owner gets OWNER access, and project team members get access according to their roles.
  • publicRead: Object owner gets OWNER access, and allUsers get READER access.
If iamConfiguration.uniformBucketLevelAccess.enabled is set to true, requests that include this parameter fail with a 400 Bad Request response.
projection string Set of properties to return. Defaults to full.

Acceptable values are:
  • full: Include all properties.
  • noAcl: Omit owner, acl, defaultObjectAcl, and ipFilter properties.

Request body

In the request body, supply a bucket resource with the following properties:

Property name Value Description Notes
Required Properties
acl[] list

Access controls on the bucket. If empty, this parameter is ignored. Can contain one or more bucketAccessControls Resources.

 writable
Optional Properties
autoclass object The bucket's Autoclass configuration, which, when enabled, controls the storage class of objects based on how and when the objects are accessed. For more information, see Autoclass. writable
billing object The bucket's billing configuration, used to control the Requester Pays feature. writable
cors[] list The bucket's CORS configuration. For more information, see Cross-Origin Resource Sharing. writable
defaultEventBasedHold boolean Whether or not to automatically apply an eventBasedHold to new objects added to the bucket. writable
defaultObjectAcl[] list Default access controls to apply to new objects when no ACL is provided. This list defines an entity and role for one or more defaultObjectAccessControls Resources. If iamConfiguration.uniformBucketLevelAccess.enabled is set to true, this field is omitted in responses, and requests that specify this field fail with a 400 Bad Request response. writable
encryption object The bucket's encryption configuration. writable
iamConfiguration object The bucket's IAM configuration. writable
ipFilter (preview) object The bucket IP filtering configuration . For more information about bucket IP filtering, see Bucket IP filtering. writable
labels object User-provided bucket labels, in key/value pairs. writable
labels.(key) string An individual label entry. writable
lifecycle object The bucket's lifecycle configuration. See lifecycle management for more information. writable
logging object The bucket's logging configuration. For more information, see usage logs and storage logs. writable
retentionPolicy object The bucket's retention policy configuration. For more information, see Bucket Lock. writable
rpo string The recovery point objective for cross-region replication of the bucket. Applicable only for dual- and multi-region buckets. "DEFAULT" uses default replication. "ASYNC_TURBO" enables turbo replication, valid for dual-region buckets only. For more information, see redundancy across regions. writable
softDeletePolicy object The bucket's soft delete policy configuration. For more information, see Soft Delete. writeable
storageClass string The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. For available storage classes, see Storage classes. writable
versioning object The bucket's versioning configuration. For more information, see Object Versioning. writable
website object The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. writable

Response

If successful, this method returns a bucket resource in the response body.

For information about status and error codes returned by this API, see the reference page.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.