/b

GET

buckets

Retrieves a list of buckets for a given project.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://storage.googleapis.com/storage/v1beta2/b?project='

Response Example

{
    "items": [
        {
            "acl": [
                {
                    "bucket": "string",
                    "domain": "string",
                    "email": "string",
                    "entity": "string",
                    "entityId": "string",
                    "etag": "string",
                    "id": "string",
                    "kind": "storage#bucketAccessControl",
                    "role": "string",
                    "selfLink": "string"
                }
            ],
            "cors": [
                {
                    "maxAgeSeconds": 0,
                    "method": [
                        "string"
                    ],
                    "origin": [
                        "string"
                    ],
                    "responseHeader": [
                        "string"
                    ]
                }
            ],
            "defaultObjectAcl": [
                {
                    "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"
                }
            ],
            "etag": "string",
            "id": "string",
            "kind": "storage#bucket",
            "lifecycle": {
                "rule": [
                    {
                        "action": {
                            "type": "string"
                        },
                        "condition": {
                            "age": 0,
                            "createdBefore": "2019-08-24",
                            "isLive": true,
                            "numNewerVersions": 0
                        }
                    }
                ]
            },
            "location": "string",
            "logging": {
                "logBucket": "string",
                "logObjectPrefix": "string"
            },
            "metageneration": "string",
            "name": "string",
            "owner": {
                "entity": "string",
                "entityId": "string"
            },
            "selfLink": "string",
            "storageClass": "string",
            "timeCreated": "2019-08-24T14:15:22Z",
            "versioning": {
                "enabled": true
            },
            "website": {
                "mainPageSuffix": "string",
                "notFoundPage": "string"
            }
        }
    ],
    "kind": "storage#buckets",
    "nextPageToken": "string"
}

Request

Query Params

project

string

required

A valid API project identifier.

maxResults

integer

optional

Maximum number of buckets to return.

pageToken

string

optional

A previously-returned page token representing part of the larger set of results to view.

projection

string

optional

Set of properties to return. Defaults to noAcl.

Responses

🟢200Successful response

application/json

Body

A list of buckets.

items

array[object (Bucket) {17}]

optional

The list of items.

acl

array[object (BucketAccessControl) {10}]

optional

Access controls on the bucket.

cors

array [object {4}]

optional

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

defaultObjectAcl

array[object (ObjectAccessControl) {12}]

optional

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

etag

string

optional

HTTP 1.1 Entity tag for the bucket.

string

optional

The ID of the bucket.

kind

string

optional

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

Default:

storage#bucket

lifecycle

object

optional

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

location

string

optional

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

logging

object

optional

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

metageneration

string <int64>

optional

The metadata generation of this bucket.

name

string

optional

The name of the bucket.

owner

object

optional

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

selfLink

string

optional

The URI of this bucket.

storageClass

string

optional

The bucket's storage class. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Typical values are STANDARD and DURABLE_REDUCED_AVAILABILITY. Defaults to STANDARD. See the developer's guide for the authoritative list.

timeCreated

string <date-time>

optional

Creation time of the bucket in RFC 3339 format.

versioning

object

optional

The bucket's versioning configuration.

website

object

optional

The bucket's website configuration.

kind

string

optional

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

Default:

storage#buckets

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.

Modified at 2023-08-15 08:12:16