Neon API (unofficial showcase)
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.

3 parameters
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID
database_namestringrequired
The database name

2 status codes
200Returns the Neon Data API for the specified branch
urlstringrequired
The URL of the Neon Data API
statusstringrequired
The status of the Neon Data API deployment
settingsobjectoptional
Configuration settings for the Data API (SubZero only)
available_schemasarray<string>optional
List of available database schemas (SubZero only)
observed_atstringoptional
When `settings` and `available_schemas` were read from the database. While the compute is suspended they are served from that read, so a change made directly in the database since then shows up in the first response served while the compute is active.
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.
request_idstringoptional
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.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: 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.