---
title: "Get branch storage state"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/storage"
tags: ["Storage"]
---

# Get branch storage state

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

Returns whether branchable object-storage is usable for the specified
branch. A 200 response means the branch is registered in the storage
service and the S3 data plane will accept requests for it. A 404
response includes a `reason` field indicating why storage is unavailable.

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

## Response `200`

Storage is enabled for this branch

- BranchStorage
  - `enabled` boolean, required — Always `true` in 200 responses. Present for forward compatibility: a future version may add intermediate states; callers should treat `true` as "storage is usable for this branch right now."
  - `s3_endpoint` string, uri, required — The S3-compatible endpoint URL for this branch.
  - `region` string, required — The AWS region for this branch's storage. The platform normalizes the us-east-1 convention server-side: a non-empty region string is always returned in 200 responses (e.g. `"us-east-1"` for the S3 default region).
  - `force_path_style` boolean, required — Whether the S3 client must use path-style addressing (bucket-in-path rather than virtual-hosted subdomain). Always true: the wildcard TLS cert covers one level of subdomain (*.storage.<suffix>), so the branch ID occupies that label and the bucket name must travel in the request path, not as a further subdomain. Callers must set the S3 SDK's ForcePathStyle (or equivalent) to true.

## Other responses

- `404` — Storage is not enabled for this branch, or the project/branch was not found. The body is always `BranchStorageNotEnabled` — see `reason` for the exact cause.
- `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.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neon/neon-api/revisions/cfde79a5c713/schema)