Appearance
neon.data_api.enable ​
Enable 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 | — | Local NeonDatabase row; if omitted, db_name is required |
db_name | string | No | — | Database name when neon_database_uuid is not provided |
auth_provider | string | No | — | neon_auth |
jwks_url | string | No | — | — |
provider_name | string | No | — | — |
jwt_audience | string | No | — | — |
add_default_grants | boolean | No | — | — |
skip_auth_schema | boolean | No | — | — |
settings | json | 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 | — | Local NeonDatabase row; if omitted, db_name is required |
db_name | string | No | — | Database name when neon_database_uuid is not provided |
auth_provider | string | No | — | neon_auth |
jwks_url | string | No | — | — |
provider_name | string | No | — | — |
jwt_audience | string | No | — | — |
add_default_grants | boolean | No | — | — |
skip_auth_schema | boolean | No | — | — |
settings | json | No | — | — |
actor | string | No | — | — |
neon_project_id | string | No | — | — |
neon_branch_id | string | No | — | — |
data_api_url | string | No | — | — |
provider_metadata | json | No | — | — |
enabled_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 | — | enable | Inputs accepted |
enabling | No | No | — | complete | Calling neon.data_apis.create |
completed | No | Yes | Yes | — | Data API enabled |
failed | No | Yes | No | — | Enable failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | enable | enabling | — |
enabling | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "neon.data_api.enable",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"neon_branch_uuid": "value"
}
}