Create Neon Data API

post

https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/data-api/{database_name}

Creates a new instance of Neon Data API in the specified branch.
The Data API exposes a REST interface over the branch database. The database_name path parameter determines which database the API serves.

Path Params

project_id

string

required

^[a-z0-9-]{1,60}$

The Neon project ID

branch_id

string

required

^[a-z0-9-]{1,60}$

The Neon branch ID

database_name

string

required

The database name

Body Params

Create Neon Data API

auth_provider

string

enum

Authentication provider for the Neon Data API. neon_auth: use Neon's built-in managed authentication (no JWKS configuration required). external: use an external JWT provider, which requires jwks_url. When omitted, no auth provider is configured (existing setup is kept).

Allowed:

jwks_url

uri

URL of the JWKS endpoint used to verify JWTs for this Data API. Required when configuring JWT-based authentication; omit when using a non-JWT auth provider.

provider_name

string

Display name for the authentication provider. Accepted values include "Clerk", "Stytch", and "Auth0", but any non-empty string is valid. Optional field.

jwt_audience

string

Expected aud claim in incoming JWTs. When set, tokens with a different audience are rejected; tokens with no audience are still accepted. Omit to skip audience validation.

add_default_grants

boolean

Defaults to false

Grant all permissions to the tables in the public schema to authenticated users

skip_auth_schema

boolean

Defaults to false

Skip creating the auth schema and RLS functions

settings

object

Auth and schema configuration for the Data API.

Responses

201Creates a new app