Skip to content
Proud to collaborate with Microsoft for Startups

neon.endpoints.get_connection_uri ​

DISABLED: does not return a Neon connection URI. Use neon.query.run or sql.query.run.

DISABLED — does not return a postgres DSN.

Use neon.query.run or sql.query.run instead. The pure helper fetch_connection_uri remains for inline mint-and-use inside those workflows.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Cloud connection holding the Neon credential
neon_project_idstringYes—Neon project id
neon_branch_idstringNo—Neon branch id (defaults to primary branch)
db_namestringNo—Database name (defaults to project default)
role_namestringNo—Role to authenticate as (defaults to project default)
pooledbooleanNo—Request the pooled (PgBouncer) endpoint host (default False)

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
neon_project_idstringNo——
neon_branch_idstringNo——
db_namestringNo——
role_namestringNo——
pooledbooleanNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "neon.endpoints.get_connection_uri",
  "initial_data": {
    "neon_project_id": "value"
  }
}