Retrieve connection URI

API Reference / Projects / Retrieve connection URI

Retrieves a connection URI for the specified database. The URI uses the standard PostgreSQL connection string format. Set pooled=true to include the -pooler suffix for a connection pooler URI.

• project_id (string, path, required) The Neon project ID
• branch_id (string, query, optional) The branch ID. Defaults to your project's default branch_id if not specified.
• endpoint_id (string, query, optional) The endpoint ID. Defaults to the read-write endpoint_id associated with the branch_id if not specified.
• database_name (string, query, required) The database name
• role_name (string, query, required) The role name
• pooled (boolean, query, optional) Adds the -pooler option to the connection URI when set to true, creating a pooled connection URI.

{
  "uri": "postgresql://[user]:[password]@ep-cool-darkness-a5b6c7d8.us-east-2.aws.neon.tech/dbname?sslmode=require&channel_binding=require"
}

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/connection_uri?database_name=$DATABASE_NAME&role_name=$ROLE_NAME" \
  -H "Authorization: Bearer $NEON_API_KEY"

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getConnectionUri({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID
  },
  query: {
    database_name: process.env.DATABASE_NAME,
    role_name: process.env.ROLE_NAME
  }
});

# neonctl
neon connection-string [branch]

Tool: get_connection_string

Get a PostgreSQL connection string for a Neon database. All parameters are optional; the tool resolves the project, branch, and database automatically if not specified. Requires write access: the connection string carries a privileged role password, so it is unavailable in read-only mode. A read-only caller who needs a DATABASE_URL must copy it from https://console.neon.tech manually.

• projectId (string, required) The ID of the project. If not provided, the only available project will be used.
• branchId (string, optional) The ID or name of the branch. If not provided, the default branch will be used.
• computeId (string, optional) The ID of the compute/endpoint. If not provided, the read-write compute associated with the branch will be used.
• databaseName (string, optional)
• roleName (string, optional) The name of the role to connect with. If not provided, the database owner name will be used.

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.

• request_id (string, optional) 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.

• code (string, required) Machine-readable code classifying the error type. See message for a human-readable explanation. Default: ``

• message (string, required) Error message