Objects: patch

Updates a data blob's associated metadata. This method supports patch semantics. Try it now.

The authenticated user must have sufficient permission to use this method.

To patch an object encrypted by a customer-supplied encryption key and retrieve the content hashes in the response, use the headers listed on the Customer-Supplied Encryption page in your request. Without such headers, the content hashes are omitted in the response.

Request

HTTP request

PATCH https://storage.googleapis.com/storage/v1/b/bucket/o/object

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 the bucket in which the object resides.
object string Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI path parts.
Optional query parameters
generation long If present, selects a specific revision of this object (as opposed to the latest version, the default).
ifGenerationMatch long Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
ifGenerationNotMatch long Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
ifMetagenerationMatch long Makes the operation conditional on whether the object's current metageneration matches the given value.
ifMetagenerationNotMatch long Makes the operation conditional on whether the object's current metageneration does not match the given value.
predefinedAcl string Apply a predefined set of access controls to this object.

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 the owner, acl property.

Request body

In the request body, supply the relevant portions of an object resource, according to the rules of patch semantics.

Response

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

Try it!

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