/projects/{project_id}/connection_uriRetrieve 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.
Quick start
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.
neon connection-string [branch]Parameters
project_idThe Neon project ID
branch_idThe branch ID. Defaults to your project's default branch_id if not specified.
endpoint_idThe endpoint ID. Defaults to the read-write endpoint_id associated with the branch_id if not specified.
database_nameThe database name
role_nameThe role name
pooledAdds the -pooler option to the connection URI when set to true, creating a pooled connection URI.
Response
200Returned the connection URI
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.