Create branch

Creates a branch in the specified project.
No request body is required, but you can specify one to create a compute endpoint or select a non-default parent branch.
By default, the branch is created from the project's default branch with no compute endpoint, and the branch name is auto-generated.
To access the branch, add a read_write endpoint.
Each branch supports one read-write endpoint and multiple read-only endpoints.
For related information, see Manage branches.

Path Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID

Body Params
endpoints
array of objects

Compute endpoints to create together with the branch. If omitted, the branch is created without any compute endpoint. Endpoints can be added to the branch separately after creation.

endpoints
branch
object

Optional configuration for the new branch, for example name, parent_id (fork from a branch), parent_lsn or parent_timestamp (point-in-time branching), and protected.

annotation_value
object

A free-form map of string key-value pairs for attaching metadata to a resource (for example, a git commit reference). Maximum 50 entries.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json