Skip to main content
POST
Preflight Connector Endpoint
Preflight checks reachability, writer status, logical replication settings, slot capacity, plugin availability, permissions, and whether the source is already connected — without creating anything. A failed check is still a 200 — read preflight_pass in the response. When grants are the problem, grant_script holds ready-to-run SQL that fixes them.

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. Nothing is stored.

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.

database
string | null

Database to render in the grant script. Affects only grant_script.

environment_id
string | null

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

org_id
string | null

Organization to preflight for. Inferred from your auth when omitted.

Private connection for the source database; needs use_environment.

selected_schemas
string[] | null

Schemas to render in the grant script. Affects only grant_script.

use_environment
boolean
default:false

Route preflight through a customer-cloud environment.

Response

The full preflight report. A failed gate is still a 200 — read preflight_pass.

branching_prerequisites_pass
boolean | null

True when the checks required for branching pass.

checks
Checks · object | null

Individual check results, keyed by check name.

grant_script
string | null

Ready-to-run SQL grant script for the source database.

preflight_pass
boolean | null

True when every preflight check passes.

source_metadata
Source Metadata · object | null

Metadata gathered from the source during preflight.

source_placement
Source Placement · object | null
source_preflight
Source Preflight · object | null
source_provider
string | null

Detected source provider, for example supabase or vanilla.