# Get branch object 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 object storage
service and the S3 data plane will accept requests for it. A 404
response includes a `reason` field indicating why object storage is unavailable.

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

Base URL: `https://console.neon.tech/api/v2`

Tags: `Storage`

## Authorization

Any ONE of the following options authorizes this operation; every scheme listed within an option is required together.

| Option | Scheme | Type | Sent as | Scopes |
| --- | --- | --- | --- | --- |
| Option 1 | `BearerAuth` | `http` | `Authorization: Bearer <token>` | — |
| Option 2 | `CookieAuth` | `apiKey` | cookie `zenith` | — |
| Option 3 | `TokenCookieAuth` | `apiKey` | cookie `keycloak_token` | — |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `project_id` | `string` | Yes | The Neon project ID |
| `branch_id` | `string` | Yes | The Neon branch ID |

## Responses

| Status | Description | Media type |
| --- | --- | --- |
| `200` | Object storage is enabled for this branch | `application/json` |
| `404` | Object 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. | `application/json` |
| `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. | `application/json` |

### Example response: 200 — Object storage is enabled for this branch

```json
{
  "enabled": true,
  "force_path_style": true,
  "region": "us-east-2",
  "s3_endpoint": "https://br-cool-moon-42.storage.c-2.local.neon.build"
}
```

### Example response: 404 — Object 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.

```json
{
  "code": "STORAGE_NOT_ENABLED",
  "message": "string",
  "reason": "branch_directory_missing"
}
```

### Example response: 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.

```json
{
  "code": "",
  "message": "string",
  "request_id": "string"
}
```

## Related pages

- [Accept a project transfer request](./acceptprojecttransferrequest.md)
- [Add an OAuth provider](./addneonauthoauthprovider.md)
- [Add an OAuth provider](./addbranchneonauthoauthprovider.md)
- [Add domain to redirect_uri whitelist](./addbranchneonauthtrusteddomain.md)
- [Add JWKS URL](./addprojectjwks.md)
- [Add trusted redirect URI domain](./addneonauthdomaintoredirecturiwhitelist.md)
- [AI Gateway](./tags/ai-gateway.md)
- [API Key](./tags/api-key.md)
- [Assign or update VPC endpoint](./assignorganizationvpcendpoint.md)
- [Auth](./tags/auth.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.