# Retrieve connection URI

`GET /projects/{project_id}/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.

[Markdown for AI context](/guides/apis-sdks-reference-api-projects-get-connection-uri)

```bash title="REST API - curl"
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"
```

Every field below is optional. An empty body works too.

Also available in

::::tabs
:::tab{title="CLI"}
```bash
neon connection-string [branch]
```
:::

:::tab{title="SDK"}
:::

:::tab{title="MCP"}
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.
:::
::::

## Parameters

Project ID

`project_id`

string

The Neon project ID

Branch ID

`branch_id`

string

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

Endpoint ID

`endpoint_id`

string

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

Database name

`database_name`

string

The database name

Role name

`role_name`

string

The role name

Pooled

`pooled`

boolean

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

## Response

200

Returned the connection URI

::::tabs
:::tab{title="schema"}
Depth
:::

:::tab{title="example"}
:::
::::

"uri": (string),req

## Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

- `message` Required. Human-readable error message.
- `code` Required. Machine-readable error code.
- `request_id` Optional. Request identifier for debugging. You can provide one with the `X-Request-ID` header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (`GET`, `HEAD`, `OPTIONS`) are generally safe to retry after a network error or timeout. Non-idempotent methods (`POST`, `PATCH`, `DELETE`, `PUT`) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with `423 Locked` or `503 Service Unavailable` are safe to retry. `423 Locked` means the resource is temporarily locked, usually because another operation is in progress.

## Related pages

- [Accept a project transfer request](./apis-sdks-reference-api-projects-accept-project-transfer-request.md)
- [Add JWKS URL](./apis-sdks-reference-api-projects-add-project-jwks.md)
- [Create a project transfer request](./apis-sdks-reference-api-projects-create-project-transfer-request.md)
- [Create project](./apis-sdks-reference-api-projects-create-project.md)
- [Delete JWKS URL](./apis-sdks-reference-api-projects-delete-project-jwks.md)
- [Delete project](./apis-sdks-reference-api-projects-delete-project.md)
- [Delete VPC endpoint restriction](./apis-sdks-reference-api-projects-delete-project-vpc-endpoint.md)
- [Grant project access](./apis-sdks-reference-api-projects-grant-permission-to-project.md)
- [List available shared preload libraries](./apis-sdks-reference-api-projects-get-available-preload-libraries.md)
- [List JWKS URLs](./apis-sdks-reference-api-projects-get-project-jwks.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.