neon.data_api.disable

Disable the Neon Data API on a tracked branch database

Overview

Property	Value
Workflow type	Linear
Library	App-neon
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_branch_uuid	uuid	Yes	—	—
neon_database_uuid	uuid	No	—	—
db_name	string	No	—	—
actor	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
cloud_connection_uuid	uuid	Yes	—	—
neon_branch_uuid	uuid	Yes	—	—
neon_database_uuid	uuid	No	—	—
db_name	string	No	—	—
actor	string	No	—	—
neon_project_id	string	No	—	—
neon_branch_id	string	No	—	—
deleted	boolean	No	—	—
disabled_at	string	No	—	—
failed_at	string	No	—	—
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
initiated	Yes	No	—	disable	Inputs accepted
disabling	No	No	—	complete	Calling neon.data_apis.delete
completed	No	Yes	Yes	—	Data API disabled
failed	No	Yes	No	—	Disable failed

State Diagram

Transitions

From	Action	To	Description
initiated	disable	disabling	—
disabling	complete	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "neon.data_api.disable",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "neon_branch_uuid": "value"
  }
}