Create a bucket on the branch

Creates a new branchable object storage bucket on the specified branch.

POST /projects/{project_id}/branches/{branch_id}/bucketsbeta

Creates a new branchable object storage bucket on the specified branch. Buckets are managed by the Neon Platform branchable object storage service.

Note: This endpoint is currently in Beta.

Markdown for AI context

REST API - curl

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/buckets" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

Bash

neon buckets create <branch_id>

Parameters

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

Request body

1 required Required: name.

Name

name

string

The bucket name.

≥1 chars, ≤255 chars

Access level

access_level

stringdefault: private

Access level for the bucket. Defaults to private. Set to public_read to allow anonymous GetObject/HeadObject on objects in this bucket.

privatepublic_read

Response

201

Bucket created

Depth

Errors

410

The project has been deleted

default

General error

This endpoint can return the standard Neon API error response.

Response fields

message Required. Human-readable error message.
code Required. Machine-readable error code.
request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

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.