Retrieve connection URI

Retrieves a connection URI for the specified database. You can obtain a project_id by listing the projects for your Neon account. You can obtain the database_name by listing the databases for a branch. You can obtain a role_name by listing the roles for a branch.

Path Params
string
required

The Neon project ID

Query Params
string

The branch ID. Defaults to your project's default branch_id if not specified.

string

The endpoint ID. Defaults to the read-write endpoint_id associated with the branch_id if not specified.

string
required

The database name

string
required

The role name

boolean

Adds the -pooler option to the connection URI when set to true, creating a pooled connection URI.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json