/projects/{project_id}/branches/{branch_id}/storagebetaGet branch storage state
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.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/storage" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createApiClient } from '@neondatabase/api-client';
const api = createApiClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await api.getProjectBranchStorage(process.env.PROJECT_ID, process.env.BRANCH_ID);Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Response
200Storage is enabled for this branch
Errors
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.
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.