younifyd
Menu

Storage.buckets.list

Retrieves a list of buckets for a given project.

GET/b

Use it in a workflow

  1. Add a step and choose the Google Cloud Storage connector.
  2. Pick the Storage.buckets.list action (under buckets).
  3. Fill in the fields below, then reference the result from later steps as {{storageBucketsList.response.data}}.

Request

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.

projectstringrequired

A valid API project identifier.

maxResultsinteger

Maximum number of buckets to return in a single response. 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 buckets whose names begin with this prefix.

projectionstring

Set of properties to return. Defaults to noAcl.

One offullnoAcl

userProjectstring

The project to be billed for this request.

Response

Returns 200 with an object. Read it in later steps with {{storageBucketsList.response.data.<field>}}.

itemsarray<object>

The list of items.

aclarray<object>11 fields

Access controls on the bucket.

autoclassobject2 fields

The bucket's Autoclass configuration.

billingobject1 fields

The bucket's billing configuration.

corsarray<object>4 fields

The bucket's Cross-Origin Resource Sharing (CORS) configuration.

customPlacementConfigobject1 fields

The bucket's custom placement configuration for Custom Dual Regions.

defaultEventBasedHoldboolean

The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, 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 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. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.

defaultObjectAclarray<object>13 fields

Default access controls to apply to new objects when no ACL is provided.

encryptionobject1 fields

Encryption configuration for a bucket.

etagstring

HTTP 1.1 Entity tag for the bucket.

iamConfigurationobject3 fields

The bucket's IAM configuration.

idstring

The ID of the bucket. For buckets, the id and name properties are the same.

kindstring

The kind of item this is. For buckets, this is always storage#bucket.

Default "storage#bucket"

labelsobject

User-provided labels, in key/value pairs.

lifecycleobject1 fields

The bucket's lifecycle configuration. See lifecycle management for more information.

locationstring

The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.

locationTypestring

The type of the bucket location.

loggingobject2 fields

The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.

metagenerationstring (int64)

The metadata generation of this bucket.

namestring

The name of the bucket.

ownerobject2 fields

The owner of the bucket. This is always the project team's owner group.

projectNumberstring (uint64)

The project number of the project the bucket belongs to.

retentionPolicyobject3 fields

The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.

rpostring

The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.

satisfiesPZSboolean

Reserved for future use.

selfLinkstring

The URI of this bucket.

storageClassstring

The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.

timeCreatedstring (date-time)

The creation time of the bucket in RFC 3339 format.

updatedstring (date-time)

The modification time of the bucket in RFC 3339 format.

versioningobject1 fields

The bucket's versioning configuration.

websiteobject2 fields

The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.

kindstring

The kind of item this is. For lists of buckets, this is always storage#buckets.

Default "storage#buckets"

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.

json
{
  "items": [
    {
      "acl": [
        {
          "bucket": "string",
          "domain": "string",
          "email": "string",
          "entity": "string",
          "entityId": "string",
          "etag": "string",
          "id": "string",
          "kind": "storage#bucketAccessControl",
          "projectTeam": {
            "projectNumber": "string",
            "team": "string"
          },
          "role": "string",
          "selfLink": "string"
        }
      ],
      "autoclass": {
        "enabled": false,
        "toggleTime": "2025-01-01T00:00:00Z"
      },
      "billing": {
        "requesterPays": false
      },
      "cors": [
        {
          "maxAgeSeconds": 0,
          "method": [
            "string"
          ],
          "origin": [
            "string"
          ],
          "responseHeader": [
            "string"
          ]
        }
      ],
      "customPlacementConfig": {
        "dataLocations": [
          "string"
        ]
      },
      "defaultEventBasedHold": false,
      "defaultObjectAcl": [
        {
          "bucket": "string",
          "domain": "string",
          "email": "string",
          "entity": "string",
          "entityId": "string",
          "etag": "string",
          "generation": "string",
          "id": "string",
          "kind": "storage#objectAccessControl",
          "object": "string",
          "projectTeam": {
            "projectNumber": "string",
            "team": "string"
          },
          "role": "string"
        }
      ],
      "encryption": {
        "defaultKmsKeyName": "string"
      },
      "etag": "string",
      "iamConfiguration": {
        "bucketPolicyOnly": {
          "enabled": false,
          "lockedTime": "2025-01-01T00:00:00Z"
        },
        "publicAccessPrevention": "string",
        "uniformBucketLevelAccess": {
          "enabled": false,
          "lockedTime": "2025-01-01T00:00:00Z"
        }
      },
      "id": "string",
      "kind": "storage#bucket"
    }
  ],
  "kind": "storage#buckets",
  "nextPageToken": "string"
}

Need more? See the Google Cloud Storage guide for connection setup and behaviour shared by every action.