Skip to main content
POST
Discover Connector Endpoint
Starts async discovery of the source’s schemas and tables. Returns an operation handle — poll it like any other operation. If discovery is already running, the call joins it instead of starting another.

Authorizations

Authorization
string
header
required

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

Path Parameters

connector_id
string
required

Response

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

operation_id
string
required

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

resource_id
string | null
required

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

status
enum<string>
required

Status at acceptance time.

Available options:
pending,
running,
completed,
failed
type
enum<string>
required

The kind of work this operation tracks, for example branch_create.

Available options:
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
prerequisites
Prerequisites · object | null

Pre-discovery prerequisite check results.

source_metadata
Source Metadata · object | null

Metadata gathered from the source.