Graphon API

S3 · Buckets

ListBuckets

GET/

Lists the buckets in the workspace of the key.

Returns one page of buckets, in name order. A key sees only the buckets of its own workspace.

View as Markdown
Role
Viewer or higher
Support
Supported
Auth
SigV4 with your API key
  • Lists the buckets in the key's workspace, in name order.
  • Storage ignores prefix and bucket-region.

Query parameters

max-bucketsintegeroptional

The most buckets to return, from 1 through 1,000.

Default: 1000

continuation-tokenstringoptional

The ContinuationToken of the previous page. Send it to get the next page.

Responses

200OK

The buckets of the workspace.

application/xml

ListAllMyBucketsResultobjectrequired

The root element.

Owner.IDstring

The workspace ID.

Buckets.Bucketarray

One element for each bucket.

IsTruncatedboolean

true when more buckets follow.

ContinuationTokenstring

Present when IsTruncated is true. Send it as continuation-token to get the next page.

Errors

Select an error in the response example to see its XML body. Any request can also get the common errors, such as SignatureDoesNotMatch.

403AccessDenied

The key does not have the role for this operation, or the bucket is in another workspace.

What to do: Use a key of the workspace that owns the bucket, with the role above.

Was this page helpful?