Sign in
Storage

Get branch object storage state

Changed on

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.

get/projects/{project_id}/branches/{branch_id}/storage

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/storage
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Object storage is enabled for this branch

enabledboolean required

Always true in 200 responses. Present for forward compatibility: a future version may add intermediate states; callers should treat true as "object storage is usable for this branch right now."

s3_endpointstring uri required

The S3-compatible endpoint URL for this branch.

regionstring required

The AWS region for this branch's object 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_styleboolean 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.

Example response

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

Changes