neon.projects.list ​
List all Neon projects in the account
List all Neon projects in the account (paginated).
Inputs:
- limit: max projects per page (optional; default 10, capped at 100).
- cursor: pagination cursor returned by a previous call (optional).
Outputs (terminal state_data):
- projects: list of provider-level project objects; each item includes id, name, region_id, pg_version (and other Neon fields). Callers must use
idas an opaque provider reference — Neon IDs are not sequential. - next_cursor: str — cursor for the next page, or empty when exhausted.
Error policy:
- 4xx → 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 |
limit | integer | No | — | Max projects per page (default 10, cap 100) |
cursor | string | No | — | Pagination cursor from a previous call |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | — |
projects | list | No | — | — |
next_cursor | string | No | — | — |
limit | integer | No | — | — |
cursor | string | 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.projects.list",
"initial_data": {
"connection_uuid": "value",
"limit": 123,
"cursor": "value"
}
}