GET Service

Lists all buckets in a specified project, ordered in the list lexicographically by name.

The GET Service method is a simple GET request without a bucket or object scope. The request returns the list of buckets in an XML document in the response body. The request must be authenticated (anonymous requests will fail). By default, only the project owners group can list buckets because they are the owner of all buckets within the project. The project team and project editors groups have only view or write access to buckets, respectively.

If the GET Service request fails, it returns a 403 Forbidden status code. The body of the error response will also contain a message describing the reason why the request failed.

The XML API does not return lists longer than 1000 buckets.

Query string parameters

This request does not typically include query string parameters.

See signed URL query string parameters for information on the parameters you include when creating and using signed URLs.

Request headers

Header Description Required
Authorization The authentication string for the request. Yes
Content-Length

The length of the request body without headers (in bytes).

* Not required for requests that use chunked transfer encoding.

Yes*
Date The date and time of the request. Yes
Host The URI for Cloud Storage. For more information, see Request Endpoints. Yes
x-goog-project-id The project ID of a project. Required unless you have set the default project for interoperable access. No
x-goog-user-project The project to be billed for charges associated with the request. No

Request body elements

This request does not include an XML document in the request body.

Request syntax

GET / HTTP/1.1
Host: storage.googleapis.com
Date: DATE
Authorization: AUTHENTICATION_STRING
Content-Length: 0
x-goog-project-id: PROJECT_ID

Response headers

The request can return a variety of response headers depending on the request headers you use.

Response body elements

Element Description
ListAllMyBucketsResult Container for bucket information.
Buckets Container for information about the owner's buckets.
Bucket Container for information about a specific bucket.
Name Name of the bucket.
CreationDate Creation date for the bucket.

Example

The following sample lists the buckets in the specified project.

Request

GET / HTTP/1.1
Host: storage.googleapis.com
Date: Mon, 15 Feb  2010 11:00:00 GMT
Content-Length: 0
x-goog-project-id: 123456789123
Authorization: Bearer ya29.AHES6ZRVmB7fkLtd1XTmq6mo0S1wqZZi3-Lh_s-6Uw7p8vtgSwg

Response

HTTP/1.1 200 OK
Content-Length: 648
Content-Type: application/xml
Date: Mon, 15 Feb  2010 11:00:01 GMT

<?xml version='1.0' encoding='utf-8'?>
<ListAllMyBucketsResult xmlns='http://doc.s3.amazonaws.com/2006-03-01'>
  <Buckets>
    <Bucket>
      <Name>city-maps</Name>
      <CreationDate>2009-12-16T18:36:25.369Z</CreationDate>
    </Bucket>
    <Bucket>
      <Name>state-maps</Name>
      <CreationDate>2009-12-16T18:42:37.408Z</CreationDate>
    </Bucket>
    <Bucket>
      <Name>country-maps</Name>
      <CreationDate>2010-01-22T01:27:03.633Z</CreationDate>
    </Bucket>
  </Buckets>
</ListAllMyBucketsResult>