Appearance
neon.branches.list ​
List all branches in a Neon project
List all branches in a Neon project by its provider (Neon) project ID.
Inputs:
- neon_project_id: Neon project ID to list branches for (required).
Outputs (terminal state_data):
- neon_project_id: str — the project ID queried
- branches: list — the raw Neon branch objects returned by the API
Error policy:
- 4xx (esp. 401/404) → WorkflowNotRetryableError (via _common.raise_for_neon_status).
- 5xx / timeouts → propagate so the engine retries.
Plugin required: context.get_plugin("neon") must expose .api_token.
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 to list branches for |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | — |
neon_project_id | string | No | — | — |
branches | list | 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.branches.list",
"initial_data": {
"neon_project_id": "value"
}
}