Objects: get

Retrieves object metadata. When alt=media is included as a query parameter in the request, this method retrieves object data.

This method supports the use of the Range header, which can be used to retrieve only part of the object data.

For examples of performing object downloads with different Cloud Storage tools and client libraries, see the Downloading Objects guide .

Required permissions

The authenticated user must have the storage.objects.get IAM permission to use this method. To return object ACLs, the authenticated user must also have the storage.objects.getIamPolicy permission.

Request

HTTP request

GET 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

alt

string

Type of data to return. Defaults to json .

Acceptable values are:

json : Return object metadata.
media : Return object data. Not supported for soft-deleted objects.

generation

long

If present, selects a specific revision of this object (as opposed to the latest version, the default). If softDeleted is true , this parameter is required.

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.

projection

string

Set of properties to return. Defaults to noAcl .

Acceptable values are:

full : Include all properties.
noAcl : Omit the owner , acl property.

restoreToken

string

Applicable in buckets with hierarchical namespace enabled. The restoreToken is a universally unique identifier (UUID) associated with each soft-deleted object .

When getting the metadata for a soft-deleted object, the restoreToken is only required when the name and generation values of the object do not uniquely identify it . Otherwise, including a restoreToken in the request is optional.

softDeleted

boolean

If true , returns the metadata of the soft-deleted object . If true , generation must also be specified, and alt=media cannot be specified.

Optional extension headers

X-Goog-Encryption-Algorithm

string

The encryption algorithm to use, which must be AES256 . Use this header if the object is encrypted with a customer-supplied encryption key and you want the object's data or content hashes returned in the response.

X-Goog-Encryption-Key

string

An RFC 4648 Base64-encoded string of your AES-256 encryption key. Use this header if the object is encrypted with a customer-supplied encryption key and you want the object's data or content hashes returned in the response.

X-Goog-Encryption-Key-Sha256

string

An RFC 4648 Base64-encoded string of the SHA256 hash of your encryption key. Use this header if the object is encrypted with a customer-supplied encryption key and you want the object's data or content hashes returned in the response.

Request body

Do not supply a request body with this method.

Response

By default, this responds with an object resource in the response body. If you provide the URL parameter alt=media , then it will respond with the object data 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.