DataAPI

Create Neon Data API

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.

post/projects/{project_id}/branches/{branch_id}/data-api/{database_name}

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/data-api/{database_name}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

auth_provider'neon_auth' | 'external'

The authentication provider to use for the Neon Data API

jwks_urlstring uri

The URL that lists the JWKS

provider_namestring

The name of the authentication provider (e.g., Clerk, Stytch, Auth0)

jwt_audiencestring

WARNING - using this setting will only reject tokens with a different audience claim. Tokens without audience claim will still be accepted.

add_default_grantsboolean

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

skip_auth_schemaboolean

Skip creating the auth schema and RLS functions

Response

Creates a new app

urlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.