---
title: ListBuckets · S3 API
description: Lists the buckets in the workspace of the key.
doc_version: 0.1.0-preview
last_updated: 2026-09-14
---

# 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.

- Role: Viewer or higher.
- Support: supported.
- Auth: AWS Signature Version 4 with your API key. See [S3 API](/api/s3.md).
- Lists the buckets in the key's workspace, in name order.
- Storage ignores `prefix` and `bucket-region`.

## Example request

```http
GET / HTTP/1.1
Host: wspq7ws2np5l8z4.storage.beta.graphon.sh
x-amz-date: 20261007T093000Z
x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Authorization: AWS4-HMAC-SHA256 Credential=<ACCESS_KEY_ID>/20261007/us-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=<SIGNATURE>
```

## Query parameters

- `max-buckets` (integer, optional): The most buckets to return, from 1 through 1,000. Default: `1000`.
- `continuation-token` (string, optional): The ContinuationToken of the previous page. Send it to get the next page.

## Responses

### 200 · OK

The buckets of the workspace.

Response body:

- `ListAllMyBucketsResult` (object, required): The root element.
  - `Owner.ID` (string, optional): The workspace ID.
  - `Buckets.Bucket` (array, optional): One element for each bucket.
    - `Name` (string, optional): The bucket name.
    - `CreationDate` (string, optional): When the bucket was created.
  - `IsTruncated` (boolean, optional): `true` when more buckets follow.
  - `ContinuationToken` (string, optional): Present when IsTruncated is `true`. Send it as `continuation-token` to get the next page.

```http
HTTP/1.1 200 OK
Content-Type: application/xml
x-amz-request-id: 4F8A2C7D1E6B4093A5C2D8E1F7B3A960

<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
  <Owner>
    <ID>wspq7ws2np5l8z4</ID>
  </Owner>
  <Buckets>
    <Bucket>
      <Name>product-manuals</Name>
      <CreationDate>2026-09-28T14:02:11.000Z</CreationDate>
    </Bucket>
    <Bucket>
      <Name>support-tickets</Name>
      <CreationDate>2026-10-01T08:15:42.000Z</CreationDate>
    </Bucket>
  </Buckets>
  <IsTruncated>false</IsTruncated>
</ListAllMyBucketsResult>
```

## Errors

Any request can also get the common errors on [S3 API](/api/s3.md).

### 403 · `AccessDenied`

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

Use a key of the workspace that owns the bucket, with the role above.

## Other request languages

### aws CLI

```bash
# The graphon profile from the S3 API overview.
export AWS_PROFILE=graphon

aws s3 ls
```

### Python (boto3)

```python
# Replace wspq7ws2np5l8z4 with your workspace ID.
import os

import boto3
from botocore.config import Config

api_key = os.environ["GRAPHON_API_KEY"]
access_key_id = api_key.split("_", 1)[1].split(".")[0]

s3 = boto3.client(
    "s3",
    endpoint_url="https://wspq7ws2np5l8z4.storage.beta.graphon.sh",
    region_name="us-east-1",
    aws_access_key_id=access_key_id,
    aws_secret_access_key=api_key,
    config=Config(signature_version="s3v4", s3={"addressing_style": "path"}),
)

response = s3.list_buckets()
for bucket in response["Buckets"]:
    print(bucket["Name"])
```

### JavaScript (AWS SDK)

```javascript
// Replace wspq7ws2np5l8z4 with your workspace ID.
import { S3Client, ListBucketsCommand } from '@aws-sdk/client-s3';

const apiKey = process.env.GRAPHON_API_KEY;
if (!apiKey) throw new Error('Set GRAPHON_API_KEY.');
const accessKeyId = apiKey.split('_')[1].split('.')[0];

const s3 = new S3Client({
  endpoint: 'https://wspq7ws2np5l8z4.storage.beta.graphon.sh',
  region: 'us-east-1',
  forcePathStyle: true,
  credentials: { accessKeyId, secretAccessKey: apiKey },
});

const response = await s3.send(new ListBucketsCommand({}));
console.log(response.Buckets?.map((bucket) => bucket.Name));
```

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.