> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryardent.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connectors API

> Preflight, create, inspect, and update Postgres connectors

A connector links Ardent to one Postgres source server. The safest API flow is the same as the CLI flow: preflight first, fix anything preflight reports, then create the connector.

## Public lifecycle

| Step                     | Endpoint                                                                                                      | Notes                                                |
| ------------------------ | ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| Preflight source         | [`POST /v1/connectors/preflight`](/api/connectors/preflight)                                                  | Checks source readiness without creating a connector |
| Create connector         | [`POST /v1/connectors`](/api/connectors/create)                                                               | Stores connector configuration and starts setup      |
| Discover schema          | [`POST /v1/connectors/{connector_id}/discover`](/api/connectors/discover)                                     | Starts async discovery when needed                   |
| Select databases/schemas | [`POST /v1/connectors/{connector_id}/selection`](/api/connectors/selection)                                   | Sets selected paths                                  |
| Submit replica decisions | [`PUT /v1/connectors/{connector_id}/replica-identity-decisions`](/api/connectors/replica-identity-decisions)  | Resolves table identity choices                      |
| Start setup              | [`POST /v1/connectors/{connector_id}/engine-setup`](/api/connectors/engine-setup)                             | Starts async setup                                   |
| Inspect connector        | [`GET /v1/connectors/{connector_id}`](/api/connectors/get)                                                    | Returns status and readiness information             |
| List connectors          | [`GET /v1/connectors?org_id={org_id}`](/api/connectors/list)                                                  | Lists connectors; `org_id` is required               |
| Update connector         | [`PUT /v1/connectors/{connector_id}`](/api/connectors/update)                                                 | Updates supported settings                           |
| Delete connector         | [`DELETE /v1/connectors/{connector_id}`](/api/connectors/delete)                                              | Starts an async delete; returns an operation         |
| Lock deletion            | [`POST /v1/connectors/{connector_id}/deletion-lock`](/api/connectors/lock)                                    | Blocks deletes until unlocked                        |
| Unlock deletion          | [`DELETE /v1/connectors/{connector_id}/deletion-lock`](/api/connectors/unlock)                                | Removes the deletion lock                            |
| List quarantines         | [`GET /v1/connectors/{connector_id}/quarantine`](/api/connectors/quarantine-list)                             | Lists paused replication deployments                 |
| Release quarantine       | [`POST /v1/connectors/{connector_id}/quarantine/{quarantine_id}/release`](/api/connectors/quarantine-release) | Resumes a paused deployment                          |

Discovery, setup, and deletion can return an operation ID — poll it with the [Operations API](/api/operations).