---
title: "List buckets on the branch"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/buckets"
tags: ["Buckets"]
---

# List buckets on the branch

`GET /projects/{project_id}/branches/{branch_id}/buckets`

Lists branchable object-storage buckets visible on the specified branch,
including those inherited from ancestor branches.

**Note**: This endpoint is currently in Private Beta.

## Response `200`

The list of buckets

- BucketsListResponse
  - `buckets` Bucket[], required
    - `name` string, required — The bucket name (unique within a branch).
    - `access_level` 'private' | 'public_read', required — Controls anonymous access to objects in the bucket. - `private`: all reads and writes require authenticated requests (default). - `public_read`: anonymous `GetObject`/`HeadObject` requests succeed; listing, writes, and deletes still require authenticated requests.
    - `created_at` string, date-time, required — When the bucket was created. For a bucket inherited from an ancestor branch this is the ancestor's creation time (the branch fork never re-creates the bucket).

## Other responses

- `default` — General Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.

---

[API](https://skmtc.net/neon/apis/neon-api.md) · [All operations](https://skmtc.net/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/neon/neon-api/revisions/cfde79a5c713/schema)