Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-connectors

Discover Connector Endpoint

Dispatch the connector's schema discovery (ARD-1098).

The connectivity + branching-prerequisites gate runs synchronously (fast after ARD-1095). On gate success the per-database catalog walk is dispatched as a connector_discovery async_operation and the endpoint returns 202 with the operation id plus the prerequisite payload — enough for the customer to know "your connection works" before the schema crawl finishes. On gate failure (network unreachable, auth, missing prereqs) the endpoint returns 422 with a structured remediation message; no worker is dispatched.

The CLI polls GET /v1/operations/{operation_id} for the terminal status of the catalog walk. Concurrent /discover calls on the same connector are deduped by the async_operations partial unique index — the second call rejoins the in-flight operation rather than launching a second crawl.

Always reads credentials from Key Vault (single source of truth). To update credentials first, call PUT /connectors/{connector_id}.

post/v1/connectors/{connector_id}/discover

Path parameters

connector_idstring required

Response

Discovery started (or joined, if one is already running). Poll the operation.

operation_idstring required

Operation to poll at GET /v1/operations/{operation_id}.

status'pending' | 'running' | 'completed' | 'failed' required

Lifecycle status of an async operation. Mirrors the async_operations_status_valid CHECK constraint.

type'connector_engine_setup' | 'connector_reset' | 'connector_deep_reset' | 'connector_discovery' | 'connector_delete' | 'connector_secret_purge' | 'connector_rollout' | 'connector_replication_rollback' | 'connector_debezium_cutover' | 'connector_debezium_shadow_cleanup' | 'environment_deploy' | 'environment_destroy' | 'branch_create' | 'branch_delete' required

Discriminator for an async operation. Must match the async_operations_type_valid CHECK constraint in the migration — extending the set requires a migration to widen the constraint AND a worker registered in the dispatcher.

resource_idstring nullable required

ID of the resource being created or acted on (the branch ID for branch create).

prerequisitesobject nullable

Pre-discovery prerequisite check results.

source_metadataobject nullable

Metadata gathered from the source.