Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon Data API API

Manage Data API configuration for branches, including enabling and disabling the PostgREST-compatible HTTP interface.

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

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

This API exposes 2 operations across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

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

2 operations 1 paths 2 schemas 1 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.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 Data API 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Data API 2

Manage Data API configuration for branches, including enabling and disabling the PostgREST-compatible HTTP interface.

GET
/projects/{project_id}/branches/{branch_id}/data-api
Get Data API configuration
getProjectBranchDataApi 2 params → 200401404
PUT
/projects/{project_id}/branches/{branch_id}/data-api
Update Data API configuration
updateProjectBranchDataApi 2 params body → 200400401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are DataApiConfigUpdate (5 properties), DataApiConfig (5 properties). Each schema is shown below with its type and property counts.

DataApiConfig
object
Configuration for the Neon Data API on a branch, providing a PostgREST-compatible HTTP interface to the database.
5 properties
DataApiConfigUpdate
object
Request body for updating Data API configuration
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-data-api-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 Branches API
Neon Consumption API
Neon Databases API
Neon Endpoints API
Neon Operations API
Neon Projects API
Neon Roles API