neon.projects.get

Fetch a single Neon project by provider ID

Fetch a single Neon project by its provider (Neon) project ID.

Inputs:

• neon_project_id: Neon project ID to fetch (required).

Outputs (terminal state_data):

• neon_project_id: str — the project ID
• name: str — project name
• region_id: str — Neon region (e.g. aws-us-east-2)
• pg_version: int — Postgres major version
• status: str — project status (provider value)
• provider_metadata: dict — full Neon response body

Error policy:

• HTTP 404 → WorkflowNotRetryableError (project not found).
• other 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	Base
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	Cloud connection holding the Neon credential
neon_project_id	string	Yes	—	Neon project ID to fetch

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	—
neon_project_id	string	No	—	—
name	string	No	—	—
region_id	string	No	—	—
pg_version	integer	No	—	—
status	string	No	—	—
provider_metadata	json	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

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

{
  "workflow_type": "neon.projects.get",
  "initial_data": {
    "connection_uuid": "value",
    "neon_project_id": "value"
  }
}