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.
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 also have the
storage.buckets.getIamPolicy
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:
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:
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:
|
Request body
In the request body, supply the relevant portions of a bucket resource, according to the rules of patch semantics.
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.