data.neon.branch.persist

Persist a NeonBranch row (create or restore)

Overview

Property	Value
Workflow type	Atomic
Library	App-neon
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_project_uuid	uuid	No	—	—
neon_project_id	string	Yes	—	—
neon_branch_id	string	Yes	—	—
name	string	No	—	—
is_primary	boolean	No	—	—
neon_parent_id	string	No	—	—
endpoint_host	string	No	—	—
endpoint_metadata	json	No	—	—
provider_metadata	json	No	—	—
actor	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
neon_branch_uuid	uuid	Yes	—	—
neon_branch_id	string	Yes	—	—
created	boolean	Yes	—	—
restored	boolean	Yes	—	—
persisted_at	string	Yes	—	—
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped step name (DAG path)
failed_layer	integer	No	—	Engine-stamped layer index (DAG path)
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name
failure_type	string	No	—	Engine-stamped failure category (atomic path)
failed_action	string	No	—	Engine-stamped action method that raised (atomic path)

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Persist branch
completed	No	Yes	Yes	—	Persisted
failed	No	Yes	No	—	Persist failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

API Usage

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

{
  "workflow_type": "data.neon.branch.persist",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "neon_project_id": "value",
    "neon_branch_id": "value"
  }
}