How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon Branches API

Manage branches within a project. Branches are copies of your data created using copy-on-write technology for development, testing, and preview environments.

Neon Branches API is one of 13 APIs that Neon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Branches. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://console.neon.tech/api/v2.

6 operations 3 paths 7 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://console.neon.tech/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Neon Branches API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Neon API keys are used to authenticate requests. Include the API key in the Authorization header as a Bearer token.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Branches 6

Manage branches within a project. Branches are copies of your data created using copy-on-write technology for development, testing, and preview environments.

GET
/projects/{project_id}/branches
List branches
listProjectBranches 1 param → 200401404
POST
/projects/{project_id}/branches
Create a branch
createProjectBranch 1 param body → 201400401404
GET
/projects/{project_id}/branches/{branch_id}
Retrieve branch details
getProjectBranch 2 params → 200401404
PATCH
/projects/{project_id}/branches/{branch_id}
Update a branch
updateProjectBranch 2 params body → 200400401404
DELETE
/projects/{project_id}/branches/{branch_id}
Delete a branch
deleteProjectBranch 2 params → 200401404
POST
/projects/{project_id}/branches/{branch_id}/restore
Restore a branch
restoreProjectBranch 2 params body → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Endpoint (14 properties), Branch (11 properties), Operation (9 properties), ConnectionUri (2 properties). Each schema is shown below with its type and property counts.

BranchCreateRequest
object
Request body for creating a new branch
2 properties
BranchUpdateRequest
object
Request body for updating a branch
1 property
Branch
object
A branch is a copy-on-write clone of your data that can be used for development, testing, or preview environments.
11 properties
EndpointCreateRequest
object
Request body for creating a new compute endpoint
1 property
Operation
object
An operation tracks the progress of an action performed on a project resource such as creating a branch, starting an endpoint, or updating a database.
9 properties
Endpoint
object
A compute endpoint provides processing resources for database queries. Each branch can have one read-write and multiple read-only endpoints.
14 properties
ConnectionUri
object
A database connection URI
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-branches-api-openapi.yml Raw ↑

Other APIs Neon publishes across the network.

Neon Data API
Neon Serverless Driver
Neon Auth
Neon API Keys API
Neon Auth API
Neon Consumption API
Neon Data API API
Neon Databases API
Neon Endpoints API
Neon Operations API
Neon Projects API
Neon Roles API
Where this information came from

This is an independent, third-party profile of Neon Branches API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.