---
title: "Retrieve Neon Data API configuration"
method: GET
path: "/projects/{project_id}/branches/{branch_id}/data-api/{database_name}"
tags: ["DataAPI"]
---

# Retrieve Neon Data API configuration

`GET /projects/{project_id}/branches/{branch_id}/data-api/{database_name}`

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

## Response `200`

Returns the Neon Data API for the specified branch

- DataAPIReponse — Neon Data API response
  - `url` string, uri, required — The URL of the Neon Data API
  - `status` string, required — The status of the Neon Data API deployment
  - `settings` DataAPISettings — Configuration settings for the Neon Data API
    - `db_aggregates_enabled` boolean — Enable aggregates feature
    - `db_anon_role` string — Database role to use for anonymous requests
    - `db_extra_search_path` string — Extra schemas to add to the search path
    - `db_max_rows` integer — Maximum number of rows that can be returned in a single request
    - `db_schemas` string[] — List of schemas to expose via the API. Default: ["public"]
    - `jwt_role_claim_key` string — JWT claim key to use for role extraction
    - `jwt_cache_max_lifetime` integer — Maximum lifetime for JWT cache in seconds
    - `openapi_mode` string — OpenAPI specification mode (ignore-privileges, disabled)
    - `server_cors_allowed_origins` string — CORS allowed origins
    - `server_timing_enabled` boolean — Enable server timing headers
  - `available_schemas` string[], nullable — List of available database schemas (SubZero only)

## Other responses

- `default` — General 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.

---

[API](https://skmtc.dev/neon/apis/neon-api.md) · [All operations](https://skmtc.dev/neon/apis/neon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/neon/neon-api/revisions/cfde79a5c713/schema)