neon.data_apis.update

Update Neon Data API settings or refresh the schema cache

Update Neon Data API configuration and/or refresh the schema cache.

Issues PATCH /projects/{neon_project_id}/branches/{neon_branch_id}/data-api/{db_name}.

An empty body refreshes the schema cache without changing settings. When settings is provided it replaces the existing settings entirely (Neon API semantics — omitted keys reset to defaults). Include jwt_role_claim_key whenever sending settings.

Inputs:

• neon_project_id: Neon project ID (required).
• neon_branch_id: Neon branch ID (required).
• db_name: Database name (required).
• settings: Full settings object to replace (optional; omit to refresh only).

Outputs (terminal state_data):

• refreshed: bool — always true on success
• settings: dict — settings that were sent (if any)
• provider_metadata: dict — raw Neon response (often empty object)

Error policy:

• 4xx → WorkflowNotRetryableError.
• 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	Yes	—	Cloud connection holding the Neon credential
neon_project_id	string	Yes	—	Neon project ID
neon_branch_id	string	Yes	—	Neon branch ID
db_name	string	Yes	—	Database name whose Data API to update
settings	json	No	—	Full settings object (replaces existing; omit to refresh only)

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	—
neon_project_id	string	No	—	—
neon_branch_id	string	No	—	—
db_name	string	No	—	—
refreshed	boolean	No	—	—
settings	json	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.data_apis.update",
  "initial_data": {
    "connection_uuid": "value",
    "neon_project_id": "value",
    "neon_branch_id": "value",
    "db_name": "value"
  }
}