neon.branches.get

Get a single Neon branch

Fetch a single Neon branch by provider project id + branch id.

Inputs:

• neon_project_id: Neon project id (required).
• neon_branch_id: Neon branch id (required).

Outputs (terminal state_data):

• neon_project_id: echoed project id
• neon_branch_id: branch id
• name: branch name
• is_primary: bool — whether this is the project's primary branch
• parent_id: Neon branch id this branch was created from (None for root)
• provider_metadata: full Neon branch object

Read-only; no DB writes. Plugin required: context.get_plugin("neon") must expose .api_token.

External call: GET https://console.neon.tech/api/v2/projects/{neon_project_id}/branches/{neon_branch_id}

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	Yes	—	Neon branch id

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	—
neon_project_id	string	No	—	—
neon_branch_id	string	No	—	—
name	string	No	—	—
is_primary	boolean	No	—	—
parent_id	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.branches.get",
  "initial_data": {
    "neon_project_id": "value",
    "neon_branch_id": "value"
  }
}