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 ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-neon |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | Cloud connection holding the Neon credential |
neon_project_id | string | Yes | — | Neon project id |
neon_branch_id | string | No | — | Neon branch id (defaults to primary branch) |
db_name | string | No | — | Database name (defaults to project default) |
role_name | string | No | — | Role to authenticate as (defaults to project default) |
pooled | boolean | No | — | Request the pooled (PgBouncer) endpoint host (default False) |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | — |
neon_project_id | string | No | — | — |
neon_branch_id | string | No | — | — |
db_name | string | No | — | — |
role_name | string | No | — | — |
pooled | boolean | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "neon.endpoints.get_connection_uri",
"initial_data": {
"neon_project_id": "value"
}
}