neon.data_apis.get

Fetch Neon Data API status and configuration

Fetch the Neon Data API status and configuration for a branch database.

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

Inputs:

• neon_project_id: Neon project ID (required).
• neon_branch_id: Neon branch ID (required).
• db_name: Database name (required).

Outputs (terminal state_data):

• data_api_url: str — REST base URL
• status: str — e.g. active
• settings: dict — current Data API settings
• available_schemas: list — schemas that can be exposed
• provider_metadata: dict — full Neon response body

Error policy:

• HTTP 404 → WorkflowNotRetryableError (Data API not enabled).
• other 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 inspect

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	—	—
data_api_url	string	No	—	—
status	string	No	—	—
settings	json	No	—	—
available_schemas	list	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.get",
  "initial_data": {
    "connection_uuid": "value",
    "neon_project_id": "value",
    "neon_branch_id": "value",
    "db_name": "value"
  }
}