Sign in
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'

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).

jwks_urlstring 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_namestring

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

jwt_audiencestring

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_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

URL of the created Data API endpoint.

Changes

No recorded changes to this operation across all 15 revisions of this API.