Retrieve Neon Data API configuration

GET/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Retrieve Neon Data API configuration

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

Parameters

project_idstringpathrequired

The Neon project ID

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

branch_idstringpathrequired

The Neon branch ID

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

database_namestringpathrequired

The database name

Responses

objectDataAPIReponse

Neon Data API response

available_schemasarray of string

List of available database schemas (SubZero only)

Show child attributes

settingsvalue

Show child attributes

anyOf · 2 options

Option 1object

Configuration settings for the Data API (SubZero only)

allOf · 1 option

Option 1objectDataAPISettings

Configuration settings for the Neon Data API

db_aggregates_enabledboolean

Enable aggregates feature

default true

db_anon_rolestring

Database role to use for anonymous requests

default "anonymous"

db_extra_search_pathstring

Extra schemas to add to the search path

db_max_rowsinteger

Hard limit on the number of rows returned in a single Data API response. No limit when unset.

db_schemasarray of string

List of schemas to expose via the API. Default: ["public"]

Show child attributes

jwt_cache_max_lifetimeinteger

Maximum lifetime of the Data API's JWT cache, in seconds.

jwt_role_claim_keystring

JWT claim key to use for role extraction

default ".role"

openapi_modestring

OpenAPI specification mode (ignore-privileges, disabled)

default "disabled"

server_cors_allowed_originsstring

CORS allowed origins

server_timing_enabledboolean

When enabled, the Data API adds `Server-Timing` headers to each response showing database execution and internal processing time. Default: disabled.

Option 2nullnullable

statusstringrequired

The status of the Neon Data API deployment

urlstring · urirequired

The URL of the Neon Data API

Example response

{
  "available_schemas": [
    "string"
  ],
  "settings": {
    "db_aggregates_enabled": true,
    "db_anon_role": "anonymous",
    "db_extra_search_path": "string",
    "db_max_rows": 0,
    "db_schemas": [
      "string"
    ],
    "jwt_cache_max_lifetime": 0,
    "jwt_role_claim_key": ".role",
    "openapi_mode": "disabled",
    "server_cors_allowed_origins": "string",
    "server_timing_enabled": true
  },
  "status": "string",
  "url": "https://example.com"
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

database_namerequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string");
using var response = await client.SendAsync(request);

{
  "available_schemas": [
    "string"
  ],
  "settings": {
    "db_aggregates_enabled": true,
    "db_anon_role": "anonymous",
    "db_extra_search_path": "string",
    "db_max_rows": 0,
    "db_schemas": [
      "string"
    ],
    "jwt_cache_max_lifetime": 0,
    "jwt_role_claim_key": ".role",
    "openapi_mode": "disabled",
    "server_cors_allowed_origins": "string",
    "server_timing_enabled": true
  },
  "status": "string",
  "url": "https://example.com"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}