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.

Caution: You should generally use thePATCH method, which changes only metadata you define in the request. The UPDATE method might change certain metadata for the bucket even if that metadata is not specified in the request.

Required permissions

To use this method,the authenticated user must have thestorage.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 tostandard query parameters, the following query parameters apply to this method.

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

Parameters

Parameter nameValueDescription
Path parameters
bucketstring Name of a bucket.
Optional query parameters
ifMetagenerationMatchlong Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
ifMetagenerationNotMatchlong Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
predefinedAclstring Apply a predefined set of access controls to this bucket.

Acceptable values are:
  • authenticatedRead: Project team owners getOWNER access, andallAuthenticatedUsers getREADER access.
  • private: Project team owners getOWNER access.
  • projectPrivate: Project team members get access according to their roles.
  • publicRead: Project team owners getOWNER access, andallUsers getREADER access.
  • publicReadWrite: Project team owners getOWNER access, andallUsers getWRITER access.
IfiamConfiguration.uniformBucketLevelAccess.enabled is set totrue, requests that include this parameter fail with a400 Bad Request response.
predefinedDefaultObjectAclstring Apply a predefined set of default object access controls to this bucket.

Acceptable values are:
  • authenticatedRead: Object owner getsOWNER access, andallAuthenticatedUsers getREADER access.
  • bucketOwnerFullControl: Object owner getsOWNER access, and project team owners getOWNER access.
  • bucketOwnerRead: Object owner getsOWNER access, and project team owners getREADER access.
  • private: Object owner getsOWNER access.
  • projectPrivate: Object owner getsOWNER access, and project team members get access according to their roles.
  • publicRead: Object owner getsOWNER access, andallUsers getREADER access.
IfiamConfiguration.uniformBucketLevelAccess.enabled is set totrue, requests that include this parameter fail with a400 Bad Request response.
projectionstring Set of properties to return. Defaults tofull.

Acceptable values are:
  • full: Include all properties.
  • noAcl: Omitowner,acl, anddefaultObjectAcl properties.

Request body

In the request body, supply abucket resource with the following properties:

Property nameValueDescriptionNotes
Required Properties
acl[]list

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

Note: ACLs do not apply in buckets whereiamConfiguration.uniformBucketLevelAccess.enabled is set totrue. Requests to such buckets fail with a400 Bad Request response if the request contains a non-emptyacl[] property.		 writable
Optional Properties
autoclassobjectThebucket's Autoclass configuration, which, when enabled, controls the storage class of objects based on how and when the objects are accessed. For more information, seeAutoclass. writable
billingobjectThebucket's billing configuration, used to control theRequester Pays feature. writable
cors[]listThebucket's CORS configuration. For more information, seeCross-Origin Resource Sharing. writable
defaultEventBasedHoldbooleanWhether or not to automatically apply aneventBasedHold to new objects added to the bucket. writable
defaultObjectAcl[]listDefault access controls to apply to new objects when no ACL is provided. This list defines anentity androle for one or moredefaultObjectAccessControls Resources. IfiamConfiguration.uniformBucketLevelAccess.enabled is set totrue, this field is omitted in responses, and requests that specify this field fail with a400 Bad Request response. writable
encryptionobjectThebucket's encryption configuration. writable
iamConfigurationobjectThebucket's IAM configuration. writable
ipFilterobjectThebucket IP filtering configuration. For more information about bucket IP filtering, seeBucket IP filtering. writable
labelsobjectUser-providedbucket labels, in key/value pairs. writable
labels.(key)stringAn individual label entry. writable
lifecycleobjectThe bucket'slifecycle configuration. Seelifecycle management for more information. writable
loggingobjectThebucket's logging configuration. For more information, seeusage logs and storage logs. writable
retentionPolicyobjectThebucket's retention policy configuration. For more information, seeBucket Lock. writable
rpostringThe 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, seeredundancy across regions. writable
softDeletePolicyobjectThebucket's soft delete policy configuration. For more information, seeSoft Delete.writeable
storageClassstringThe bucket's default storage class, used whenever nostorageClass is specified for a newly-created object. For available storage classes, seeStorage classes. writable
versioningobjectThebucket's versioning configuration. For more information, seeObject Versioning. writable
websiteobjectThebucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See theStatic Website Examples for more information. writable

Response

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

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

Try it!

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-17 UTC.