Sign in
DataAPI

Retrieve Neon Data API configuration

Retrieves the Neon Data API configuration for the specified branch, including endpoint URL, enabled state, and database settings.

get/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

Response

Returns the Neon Data API for the specified branch

urlstring uri required

The URL of the Neon Data API

statusstring required

The status of the Neon Data API deployment

available_schemasstring[] nullable

List of available database schemas (SubZero only)

Changes

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