Retrieves a list of buckets for a given project, ordered in the list lexicographically by name.
Required permissions
The authenticated user must have the storage.buckets.list
IAM
permission to use this method. To list IAM policies for a bucket, the authenticated
user must also have the storage.buckets.getIamPolicy
permission.
Request
HTTP request
GET https://storage.googleapis.com/storage/v1/b
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 |
---|---|---|
Required query parameters | ||
project |
string |
A valid API project identifier. |
Optional query parameters | ||
maxResults |
unsigned integer |
Maximum number of buckets to return in a single response. The service may return fewer
results than maxResults so the presence of nextPageToken should
always be checked. The service limits to:
|
pageToken |
string |
A previously-returned page token representing part of the larger set of results to view. The If you start a listing and then create a new bucket before using a |
prefix |
string |
Filter results to buckets whose names begin with this prefix. |
projection |
string |
Set of properties to return. Defaults to Acceptable values are:
|
softDeleted |
boolean |
If set to true , only soft-deleted bucket versions are listed as distinct results in order of bucket name and generation number. The default value is false .
|
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "storage#buckets", "nextPageToken": string, "items": [ buckets Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
kind |
string |
The kind of item this is. For lists of buckets, this is always
"storage#buckets" . |
|
nextPageToken |
string |
The continuation token. Provide this value as the
The |
|
items[] |
list |
The list of buckets. |
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.