Buckets: patch

Stay organized with collections Save and categorize content based on your preferences.

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics. Try it now.

Required permissions

The authenticated user must have the storage.buckets.update IAM permission to use this method. To update public access prevention policies or access control lists (ACLs), the authenticated user must also have the storage.buckets.setIamPolicy permission. To return ACLs as part of the response, the authenticated user must have either the storage.buckets.getIamPolicy or storage.buckets.setIamPolicy permission.

Request

HTTP request

PATCH 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 noacl.

Note: Currently only works if you override the default and specify full.

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

Request body

In the request body, supply the relevant portions of a bucket resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Optional Properties
acl[] list Access controls on the bucket, containing one or more bucketAccessControls 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
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. writable
autoclass.enabled boolean When set to false, Autoclass is disabled for this bucket. You cannot currently enable Autoclass on existing buckets. writable
billing object The bucket's billing configuration. writable
billing.requesterPays boolean When set to true, Requester Pays is enabled for this bucket. writable
cors[] list The bucket's Cross-Origin Resource Sharing (CORS) configuration. writable
cors[].maxAgeSeconds integer The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses. writable
cors[].method[] list The list of HTTP methods on which to include CORS response headers, ("DELETE", "GET", "HEAD", "PATH", "POST", "PUT"). "OPTIONS" is interpreted as a preflight request, so you don't need to specify this method in your CORS configuration. Note: "*" is permitted in the list of methods, and means "any method". writable
cors[].origin[] list The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin". writable
cors[].responseHeader[] list The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains. 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 Encryption configuration for a bucket. writable
encryption.defaultKmsKeyName string A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
iamConfiguration object The bucket's IAM configuration. writable
iamConfiguration.publicAccessPrevention string The bucket's public access prevention status. Acceptable values are "inherited" or "enforced". If "inherited", the bucket uses public access prevention only if the bucket is subject to the public access prevention organization policy constraint. Defaults to "inherited". writable
iamConfiguration.uniformBucketLevelAccess object The bucket's uniform bucket-level access configuration.

Note: iamConfiguration also includes the bucketPolicyOnly field, which uses a legacy name but has the same functionality as the uniformBucketLevelAccess field. We recommend only using uniformBucketLevelAccess, as specifying both fields may result in unreliable behavior. 		writable
iamConfiguration.uniformBucketLevelAccess.enabled boolean Whether or not the bucket uses uniform bucket-level access. If set, access checks only use bucket-level IAM policies or above. 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, which defines the destination bucket and optional name prefix for the current bucket's logs. writable
logging.logBucket string The destination bucket where the current bucket's logs should be placed. writable
logging.logObjectPrefix string A prefix for log object names. The default prefix is the bucket name. writable
retentionPolicy object The bucket's retention policy, which defines the minimum age an object in the bucket must reach before it can be deleted or replaced. writable
retentionPolicy.retentionPeriod string The period of time, in seconds, that objects in the bucket must be retained and cannot be deleted, replaced, or made noncurrent. The value must be less than 3,155,760,000 seconds. 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 Turbo replication. writable
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. writable
versioning.enabled boolean While set to true, versioning is fully enabled for this bucket. 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
website.mainPageSuffix string If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages. writable
website.notFoundPage string If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result. writable

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

Response

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

Try it!

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