Skip to main content
POST
Create Connector Endpoint
If preflight hasn’t passed for this source, create fails with 422 and the response body is the full preflight report — fix the failures it lists and retry.
Include the environment and private connection IDs that your Ardent team has set up:
environment_id and private_link_id are only valid together with use_environment: true. Add "allow_high_rtt_placement": true to accept a far-away placement despite higher latency.

Authorizations

Authorization
string
header
required

Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.

Body

application/json
connection_details
Connection Details · object
required

Connection details for the source database.

name
string
required

Connector name.

project_id
string
required

Project to create the connector in.

service_name
string
required

Service type. postgresql is the only supported value today.

allow_high_rtt_placement
boolean
default:false

Allow customer-cloud placement far from the worker region.

drop_extensions
string[] | null

Source extensions to drop on branches instead of installing.

environment_id
string | null

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

org_id
string | null

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

Private connection for the source database; needs use_environment.

use_environment
boolean
default:false

Create the connector in a customer-cloud environment.

Response

The created connector row plus can_update/can_delete.

id
string
required

Connector ID.

name
string
required

Connector name.

org_id
string
required

Organization the connector belongs to.

service_name
string
required

Service type. postgresql today.

can_delete
boolean | null

Whether the caller may delete this connector.

can_update
boolean | null

Whether the caller may update this connector.

created_at
string | null

When the connector was created.

project_id
string | null

Project the connector belongs to.

status
string | null

Current connector status.