Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-connectors

Create Connector Endpoint

Create new connector after source prerequisite validation.

Flow:

  1. Validate connection_details schema for service_name
  2. Run the row-less PostgreSQL source prerequisite gate
  3. Store connection details in Key Vault
  4. Save connector to database
  5. Return connector (without schema_structure - call /discover next)

Response time: 500ms-1s (fast validation only)

Note: After creating, call POST /connectors/{id}/discover to run schema discovery.

Preflight gate scope: steps 1-2 run for every PostgreSQL create where byoc is None — this deliberately includes BYOC-environment (use_environment=True, ARN-based) connectors as well as direct (no-environment) connectors. For the BYOC-environment path the gate probes the source through the discovery tunnel (private_link_id + resolved byoc_access_credentials are forwarded to run_discovery_preflight), so the source is validated before any row or secret is written. Only Neon-BYOC (byoc='neon') and non-PostgreSQL creates skip the gate.

post/v1/connectors

Request body

org_idstring nullable

Organization to create the connector in. Inferred from your auth when omitted.

project_idstring required

Project to create the connector in.

namestring required

Connector name.

service_namestring required

Service type. postgresql is the only supported value today.

connection_detailsobject required

Connection details for the source database.

byocstring nullable
neon_api_keystring nullable
neon_project_idstring nullable
deployment_model'ardent-cloud' | 'customer-cloud'
use_environmentboolean

Create the connector in a customer-cloud environment.

environment_idstring nullable

Customer-cloud environment; required when your org has more than one.

private_link_idstring nullable

Private connection for the source database; needs use_environment.

allow_high_rtt_placementboolean

Allow customer-cloud placement far from the worker region.

drop_extensionsstring[] nullable

Source extensions to drop on branches instead of installing.

Response

The created connector row plus can_update/can_delete.

idstring required

Connector ID.

org_idstring required

Organization the connector belongs to.

project_idstring nullable

Project the connector belongs to.

namestring required

Connector name.

service_namestring required

Service type. postgresql today.

statusstring nullable

Current connector status.

created_atstring nullable

When the connector was created.

can_updateboolean nullable

Whether the caller may update this connector.

can_deleteboolean nullable

Whether the caller may delete this connector.