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 pageToken is an encoded field containing the name of the last item
(bucket) in the returned list. In a subsequent request using the pageToken ,
items that come after the pageToken are shown (up to maxResults ).
If you start a listing and then create a new bucket before using a pageToken
to continue listing, you will not see the new bucket in subsequent listing results if it
is in part of the bucket namespace already listed.
|
prefix |
string |
Filter results to buckets whose names begin with this prefix. |
projection |
string |
Set of properties to return. Defaults to noAcl .
Acceptable values are:
|
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 pageToken of a subsequent
request in order to return the next page of results. Note that the next page may be empty.
If this is the last page of results, then no continuation token is returned. The presence
of this parameter in the response should always be checked to ensure a complete listing of
all the results.
The nextPageToken is the name of the last bucket in the returned
list. In a subsequent list request using the pageToken , items that come after
the token are shown (up to maxResults ). |
|
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.