Cloud Storage JSON API
  1. objects
Cloud Storage JSON API
  • buckets
    • /b
      GET
    • /b
      POST
    • /b/{bucket}
      DELETE
    • /b/{bucket}
      GET
    • /b/{bucket}
      PATCH
    • /b/{bucket}
      PUT
  • bucketAccessControls
    • /b/{bucket}/acl
      GET
    • /b/{bucket}/acl
      POST
    • /b/{bucket}/acl/{entity}
      DELETE
    • /b/{bucket}/acl/{entity}
      GET
    • /b/{bucket}/acl/{entity}
      PATCH
    • /b/{bucket}/acl/{entity}
      PUT
  • defaultObjectAccessControls
    • /b/{bucket}/defaultObjectAcl
      GET
    • /b/{bucket}/defaultObjectAcl
      POST
    • /b/{bucket}/defaultObjectAcl/{entity}
      DELETE
    • /b/{bucket}/defaultObjectAcl/{entity}
      GET
    • /b/{bucket}/defaultObjectAcl/{entity}
      PATCH
    • /b/{bucket}/defaultObjectAcl/{entity}
      PUT
  • objects
    • /b/{bucket}/o
      GET
    • /b/{bucket}/o
      POST
    • /b/{bucket}/o/watch
      POST
    • /b/{bucket}/o/{object}
      DELETE
    • /b/{bucket}/o/{object}
      GET
    • /b/{bucket}/o/{object}
      PATCH
    • /b/{bucket}/o/{object}
      PUT
    • /b/{destinationBucket}/o/{destinationObject}/compose
      POST
    • /b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}
      POST
  • objectAccessControls
    • /b/{bucket}/o/{object}/acl
    • /b/{bucket}/o/{object}/acl
    • /b/{bucket}/o/{object}/acl/{entity}
    • /b/{bucket}/o/{object}/acl/{entity}
    • /b/{bucket}/o/{object}/acl/{entity}
    • /b/{bucket}/o/{object}/acl/{entity}
  • channels
    • /channels/stop
  1. objects

/b/{bucket}/o

GET
/b/{bucket}/o
objects
Retrieves a list of objects matching the criteria.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://storage.googleapis.com/storage/v1beta2/b//o'
Response Response Example
{
    "items": [
        {
            "acl": [
                {
                    "bucket": "string",
                    "domain": "string",
                    "email": "string",
                    "entity": "string",
                    "entityId": "string",
                    "etag": "string",
                    "generation": "string",
                    "id": "string",
                    "kind": "storage#objectAccessControl",
                    "object": "string",
                    "role": "string",
                    "selfLink": "string"
                }
            ],
            "bucket": "string",
            "cacheControl": "string",
            "componentCount": 0,
            "contentDisposition": "string",
            "contentEncoding": "string",
            "contentLanguage": "string",
            "contentType": "string",
            "crc32c": "string",
            "etag": "string",
            "generation": "string",
            "id": "string",
            "kind": "storage#object",
            "md5Hash": "string",
            "mediaLink": "string",
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "metageneration": "string",
            "name": "string",
            "owner": {
                "entity": "string",
                "entityId": "string"
            },
            "selfLink": "string",
            "size": "string",
            "storageClass": "string",
            "timeDeleted": "2019-08-24T14:15:22Z",
            "updated": "2019-08-24T14:15:22Z"
        }
    ],
    "kind": "storage#objects",
    "nextPageToken": "string",
    "prefixes": [
        "string"
    ]
}

Request

Path Params
bucket
string 
required
Name of the bucket in which to look for objects.
Query Params
delimiter
string 
optional
Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
maxResults
integer 
optional
Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested.
pageToken
string 
optional
A previously-returned page token representing part of the larger set of results to view.
prefix
string 
optional
Filter results to objects whose names begin with this prefix.
projection
string 
optional
Set of properties to return. Defaults to noAcl.
versions
string 
optional
If true, lists all versions of a file as distinct results.

Responses

🟢200Successful response
application/json
Body
A list of objects.
items
array[object (Object) {24}] 
optional
The list of items.
acl
array[object (ObjectAccessControl) {12}] 
optional
Access controls on the object.
bucket
string 
optional
The bucket containing this object.
cacheControl
string 
optional
Cache-Control directive for the object data.
componentCount
integer <int32>
optional
Number of underlying components that make up this object. Components are accumulated by compose operations and are limited to a count of 32.
contentDisposition
string 
optional
Content-Disposition of the object data.
contentEncoding
string 
optional
Content-Encoding of the object data.
contentLanguage
string 
optional
Content-Language of the object data.
contentType
string 
optional
Content-Type of the object data.
crc32c
string 
optional
CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64.
etag
string 
optional
HTTP 1.1 Entity tag for the object.
generation
string <int64>
optional
The content generation of this object. Used for object versioning.
id
string 
optional
The ID of the object.
kind
string 
optional
The kind of item this is. For objects, this is always storage#object.
Default:
storage#object
md5Hash
string 
optional
MD5 hash of the data; encoded using base64.
mediaLink
string 
optional
Media download link.
metadata
object 
optional
User-provided metadata, in key/value pairs.
metageneration
string <int64>
optional
The generation of the metadata for this object at this generation. Used for metadata versioning. Has no meaning outside of the context of this generation.
name
string 
optional
The name of this object. Required if not specified by URL parameter.
owner
object 
optional
The owner of the object. This will always be the uploader of the object.
selfLink
string 
optional
The link to this object.
size
string <uint64>
optional
Content-Length of the data in bytes.
storageClass
string 
optional
Storage class of the object.
timeDeleted
string <date-time>
optional
Deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
updated
string <date-time>
optional
Modification time of the object metadata in RFC 3339 format.
kind
string 
optional
The kind of item this is. For lists of objects, this is always storage#objects.
Default:
storage#objects
nextPageToken
string 
optional
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
prefixes
array[string]
optional
The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
Modified at 2023-08-15 08:12:16
Previous
/b/{bucket}/defaultObjectAcl/{entity}
Next
/b/{bucket}/o
Built with