Retrieves a list of objects matching the criteria.
GET/b/{bucket}/o
Use it in a workflow
Add a step and choose the Google Cloud Storage connector.
Pick the Storage.objects.list action (under objects).
Fill in the fields below, then reference the result from later steps as {{storageObjectsList.response.data}}.
Request
Path parameters
bucketstringrequired
Name of the bucket in which to look for objects.
Query parameters
altstring
Data format for the response.
One ofjson
fieldsstring
Selector specifying which fields to include in a partial response.
keystring
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstring
OAuth 2.0 token for the current user.
prettyPrintboolean
Returns response with indentations and line breaks.
quotaUserstring
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
uploadTypestring
Upload protocol for media (e.g. "media", "multipart", "resumable").
userIpstring
Deprecated. Please use quotaUser instead.
delimiterstring
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.
endOffsetstring
Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
includeTrailingDelimiterboolean
If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
matchGlobstring
Filter results to objects and prefixes that match this glob pattern.
maxResultsinteger
Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
pageTokenstring
A previously-returned page token representing part of the larger set of results to view.
prefixstring
Filter results to objects whose names begin with this prefix.
projectionstring
Set of properties to return. Defaults to noAcl.
One offullnoAcl
startOffsetstring
Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
userProjectstring
The project to be billed for this request. Required for Requester Pays buckets.
versionsboolean
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
Response
Returns 200 with an object. Read it in later steps with {{storageObjectsList.response.data.<field>}}.
itemsarray<object>
The list of items.
aclarray<object>13 fields
Access controls on the object.
bucketstring
The name of the bucket containing this object.
cacheControlstring
Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
componentCountinteger (int32)
Number of underlying components that make up this object. Components are accumulated by compose operations.
contentDispositionstring
Content-Disposition of the object data.
contentEncodingstring
Content-Encoding of the object data.
contentLanguagestring
Content-Language of the object data.
contentTypestring
Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
crc32cstring
CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
customTimestring (date-time)
A timestamp in RFC 3339 format specified by the user for an object.
customerEncryptionobject2 fields
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
etagstring
HTTP 1.1 Entity tag for the object.
eventBasedHoldboolean
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is the loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false.
generationstring (int64)
The content generation of this object. Used for object versioning.
idstring
The ID of the object, including the bucket name, object name, and generation number.
kindstring
The kind of item this is. For objects, this is always storage#object.
Default "storage#object"
kmsKeyNamestring
Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
md5Hashstring
MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
mediaLinkstring
Media download link.
metadataobject
User-provided metadata, in key/value pairs.
metagenerationstring (int64)
The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
namestring
The name of the object. Required if not specified by URL parameter.
ownerobject2 fields
The owner of the object. This will always be the uploader of the object.
retentionExpirationTimestring (date-time)
A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
selfLinkstring
The link to this object.
sizestring (uint64)
Content-Length of the data in bytes.
storageClassstring
Storage class of the object.
temporaryHoldboolean
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
timeCreatedstring (date-time)
The creation time of the object in RFC 3339 format.
timeDeletedstring (date-time)
The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
timeStorageClassUpdatedstring (date-time)
The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
updatedstring (date-time)
The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
kindstring
The kind of item this is. For lists of objects, this is always storage#objects.
Default "storage#objects"
nextPageTokenstring
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
prefixesarray<string>
The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
