Update Neon Data API

PATCH/projects/{project_id}/branches/{branch_id}/data-api/{database_name}Update Neon Data API

Updates the Neon Data API configuration for the specified branch. You can optionally provide settings to update the Data API configuration. The schema cache is always refreshed as part of this operation.

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

Request body

application/json

objectDataAPIUpdateRequest

Update Neon Data API

settingsobject

Configuration settings for the Neon Data API

Show child attributes

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.

Example request

{
  "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
  }
}

Responses

objectEmptyResponse

Empty response.

Example response

{}

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 PATCH 'https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string' \
  -H 'Content-Type: application/json' \
  -d '{"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}}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"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}}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"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}}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string",
    headers={"Content-Type": "application/json"},
    data='{"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}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"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}}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"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}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$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("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"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}}"))
    .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("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"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}}"
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.Patch, "https://console.neon.tech/api/v2/projects/string/branches/string/data-api/string");
request.Content = new StringContent("{\"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}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{}

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