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.
Private-network and customer-cloud connectors
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ardent","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/ardent-48ce3428/AH2Rs53EKNDde6Qn/logo/light.svg?fit=max\u0026auto=format\u0026n=AH2Rs53EKNDde6Qn\u0026q=85\u0026s=5fc04448630908a535e6ff2ec3e536f9","dark":"https://mintcdn.com/ardent-48ce3428/AH2Rs53EKNDde6Qn/logo/dark.svg?fit=max\u0026auto=format\u0026n=AH2Rs53EKNDde6Qn\u0026q=85\u0026s=13a0c6bdad819b802b712fbb50c5576e"},"favicon":"https://mintcdn.com/ardent-48ce3428/AH2Rs53EKNDde6Qn/favicon.svg?fit=max\u0026auto=format\u0026n=AH2Rs53EKNDde6Qn\u0026q=85\u0026s=41eaa659773d3642c4f994f276e5f665","navbar":{"links":[{"href":"mailto:vikram@tryardent.com","label":"Support"}],"primary":{"type":"button","label":"Log in","href":"https://app.tryardent.com"}},"footer":{},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ardent-48ce3428","hasAudioNarration":false,"actualSubdomain":"ardent-48ce3428","customDomains":["docs.tryardent.com"],"gitSource":{"type":"github","owner":"ardentailabs","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a5ebfbebd7901cdf8d1cd02","collectionId":"feb12d49-9da4-4101-8839-c79dff1174cf","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a5ebfbebd7901cdf8d1cd02"},"entitlements":{},"buildId":"6a5ebfbebd7901cdf8d1cd02:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":33},{"language":"default","tag":"Core resources","count":25},{"language":"default","tag":"Connectors","count":19},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"CLI reference","count":8},{"language":"default","tag":"CLI","count":8},{"language":"default","tag":"Projects","count":6},{"language":"default","tag":"Administration","count":5},{"language":"default","tag":"API keys","count":4},{"language":"default","tag":"Branches","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/connectors/create","slug":"/api/connectors/create","pageMetadata":{"title":"Create a connector","sidebarTitle":"Create","description":"Connect a Postgres source to Ardent","openapi":"openapi.public.json POST /v1/connectors","href":"/api/connectors/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Connect a Postgres source to Ardent\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Accordion,CodeBlock}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`If preflight hasn’t passed for this source, create fails with `,_jsx(_components.code,{children:`422`}),` and the response body is the full preflight report — fix the failures it lists and retry.`]}),`\n`,_jsxs(Accordion,{defaultOpen:false,title:`Private-network and customer-cloud connectors`,id:`private-network-and-customer-cloud-connectors`,children:[_jsx(_components.p,{children:`Include the environment and private connection IDs that your Ardent team has set up:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"use_environment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"environment_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"env_123\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"private_link_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"epl_123\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[_jsx(_components.code,{children:`environment_id`}),` and `,_jsx(_components.code,{children:`private_link_id`}),` are only valid together with `,_jsx(_components.code,{children:`use_environment: true`}),`. Add `,_jsx(_components.code,{children:`\"allow_high_rtt_placement\": true`}),` to accept a far-away placement despite higher latency.`]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a connector","sidebarTitle":"Create","description":"Connect a Postgres source to Ardent","openapi":"openapi.public.json POST /v1/connectors","href":"/api/connectors/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"create_connector_endpoint_v1_connectors_post","requestBody":"eb822a2b-9772-4472-a4e5-c5b4aa6cd730","responses":{"200":"b1f9d710-47a7-4c84-8b1f-2a9e4093c71d","400":"845fff6c-c637-44ea-8405-c6f029bcea41","422":"1dd7d3de-2b78-4c0a-af9e-ae2addb44ecf"},"security":["6f5a9696-c554-4732-b4b5-3cead6de0568"],"summary":"Create Connector Endpoint","tags":["v1-connectors"],"method":"post","type":"path","servers":["333f0374-1642-430c-9cb3-b30da5f795a0"],"path":"/v1/connectors","baseUrlOptions":["https://api.tryardent.com"],"title":"Create Connector Endpoint","description":"Connect a Postgres source to Ardent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"connection_details":{"additionalProperties":true,"description":"Connection details for the source database.","title":"Connection Details","type":"object","isRequired":true,"uniqueKey":"connection_details","typeLabel":"Connection Details · object"},"name":{"description":"Connector name.","title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"project_id":{"description":"Project to create the connector in.","title":"Project Id","type":"string","isRequired":true,"uniqueKey":"project_id","typeLabel":"string"},"service_name":{"description":"Service type. `postgresql` is the only supported value today.","title":"Service Name","type":"string","isRequired":true,"uniqueKey":"service_name","typeLabel":"string"},"allow_high_rtt_placement":{"default":false,"description":"Allow customer-cloud placement far from the worker region.","title":"Allow High Rtt Placement","type":"boolean","uniqueKey":"allow_high_rtt_placement","typeLabel":"boolean"},"drop_extensions":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"drop_extensions.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Drop Extensions","description":"Source extensions to drop on branches instead of installing.","uniqueKey":"drop_extensions.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Drop Extensions","description":"Source extensions to drop on branches instead of installing.","uniqueKey":"drop_extensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"drop_extensions","typeLabel":"string[] | null"},"environment_id":{"oneOf":[{"type":"string","title":"Environment Id","description":"Customer-cloud environment; required when your org has more than one.","uniqueKey":"environment_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Environment Id","description":"Customer-cloud environment; required when your org has more than one.","uniqueKey":"environment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"environment_id","typeLabel":"string | null"},"org_id":{"oneOf":[{"type":"string","title":"Org Id","description":"Organization to create the connector in. Inferred from your auth when omitted.","uniqueKey":"org_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Org Id","description":"Organization to create the connector in. Inferred from your auth when omitted.","uniqueKey":"org_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"org_id","typeLabel":"string | null"},"private_link_id":{"oneOf":[{"type":"string","title":"Private Link Id","description":"Private connection for the source database; needs `use_environment`.","uniqueKey":"private_link_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Private Link Id","description":"Private connection for the source database; needs `use_environment`.","uniqueKey":"private_link_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"private_link_id","typeLabel":"string | null"},"use_environment":{"default":false,"description":"Create the connector in a customer-cloud environment.","title":"Use Environment","type":"boolean","uniqueKey":"use_environment","typeLabel":"boolean"}},"required":["project_id","name","service_name","connection_details"],"title":"CreateConnectorRequest","type":"object","uniqueKey":"","typeLabel":"CreateConnectorRequest · object"},"examples":{"Example":{"title":"Example","value":{"connection_details":{},"name":"\u003cstring>","project_id":"\u003cstring>","service_name":"\u003cstring>","allow_high_rtt_placement":false,"drop_extensions":["\u003cstring>"],"environment_id":"\u003cstring>","org_id":"\u003cstring>","private_link_id":"\u003cstring>","use_environment":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"b1f9d710-47a7-4c84-8b1f-2a9e4093c71d":{"content":{"application/json":{"schema":{"additionalProperties":true,"properties":{"id":{"description":"Connector ID.","title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"description":"Connector name.","title":"Name","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"org_id":{"description":"Organization the connector belongs to.","title":"Org Id","type":"string","isRequired":true,"uniqueKey":"org_id","typeLabel":"string"},"service_name":{"description":"Service type. `postgresql` today.","title":"Service Name","type":"string","isRequired":true,"uniqueKey":"service_name","typeLabel":"string"},"can_delete":{"oneOf":[{"type":"boolean","title":"Can Delete","description":"Whether the caller may delete this connector.","uniqueKey":"can_delete.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Can Delete","description":"Whether the caller may delete this connector.","uniqueKey":"can_delete.oneOf.1","typeLabel":"null"}],"uniqueKey":"can_delete","typeLabel":"boolean | null"},"can_update":{"oneOf":[{"type":"boolean","title":"Can Update","description":"Whether the caller may update this connector.","uniqueKey":"can_update.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Can Update","description":"Whether the caller may update this connector.","uniqueKey":"can_update.oneOf.1","typeLabel":"null"}],"uniqueKey":"can_update","typeLabel":"boolean | null"},"created_at":{"oneOf":[{"type":"string","title":"Created At","description":"When the connector was created.","uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","description":"When the connector was created.","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string | null"},"project_id":{"oneOf":[{"type":"string","title":"Project Id","description":"Project the connector belongs to.","uniqueKey":"project_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Project Id","description":"Project the connector belongs to.","uniqueKey":"project_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"project_id","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","title":"Status","description":"Current connector status.","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","description":"Current connector status.","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"}},"required":["id","org_id","name","service_name"],"title":"ConnectorRow","type":"object","uniqueKey":"","typeLabel":"ConnectorRow · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","org_id":"\u003cstring>","service_name":"\u003cstring>","can_delete":true,"can_update":true,"created_at":"\u003cstring>","project_id":"\u003cstring>","status":"\u003cstring>"}}},"exampleType":"generated"}},"description":"The created connector row plus `can_update`/`can_delete`.","exampleType":"generated"},"845fff6c-c637-44ea-8405-c6f029bcea41":{"description":"Validation, placement, or private-network configuration error.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1dd7d3de-2b78-4c0a-af9e-ae2addb44ecf":{"content":{"application/json":{"schema":{"additionalProperties":true,"properties":{"branching_prerequisites_pass":{"oneOf":[{"type":"boolean","title":"Branching Prerequisites Pass","description":"True when the checks required for branching pass.","uniqueKey":"branching_prerequisites_pass.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Branching Prerequisites Pass","description":"True when the checks required for branching pass.","uniqueKey":"branching_prerequisites_pass.oneOf.1","typeLabel":"null"}],"uniqueKey":"branching_prerequisites_pass","typeLabel":"boolean | null"},"checks":{"oneOf":[{"type":"object","title":"Checks","description":"Individual check results, keyed by check name.","additionalProperties":true,"uniqueKey":"checks.oneOf.0","typeLabel":"Checks · object"},{"type":"null","title":"Checks","description":"Individual check results, keyed by check name.","uniqueKey":"checks.oneOf.1","typeLabel":"null"}],"uniqueKey":"checks","typeLabel":"Checks · object | null"},"grant_script":{"oneOf":[{"type":"string","title":"Grant Script","description":"Ready-to-run SQL grant script for the source database.","uniqueKey":"grant_script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Grant Script","description":"Ready-to-run SQL grant script for the source database.","uniqueKey":"grant_script.oneOf.1","typeLabel":"null"}],"uniqueKey":"grant_script","typeLabel":"string | null"},"preflight_pass":{"oneOf":[{"type":"boolean","title":"Preflight Pass","description":"True when every preflight check passes.","uniqueKey":"preflight_pass.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Preflight Pass","description":"True when every preflight check passes.","uniqueKey":"preflight_pass.oneOf.1","typeLabel":"null"}],"uniqueKey":"preflight_pass","typeLabel":"boolean | null"},"source_metadata":{"oneOf":[{"type":"object","title":"Source Metadata","description":"Metadata gathered from the source during preflight.","additionalProperties":true,"uniqueKey":"source_metadata.oneOf.0","typeLabel":"Source Metadata · object"},{"type":"null","title":"Source Metadata","description":"Metadata gathered from the source during preflight.","uniqueKey":"source_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_metadata","typeLabel":"Source Metadata · object | null"},"source_placement":{"oneOf":[{"type":"object","title":"Source Placement","additionalProperties":true,"uniqueKey":"source_placement.oneOf.0","typeLabel":"Source Placement · object"},{"type":"null","title":"Source Placement","uniqueKey":"source_placement.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_placement","typeLabel":"Source Placement · object | null"},"source_preflight":{"oneOf":[{"type":"object","title":"Source Preflight","additionalProperties":true,"uniqueKey":"source_preflight.oneOf.0","typeLabel":"Source Preflight · object"},{"type":"null","title":"Source Preflight","uniqueKey":"source_preflight.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_preflight","typeLabel":"Source Preflight · object | null"},"source_provider":{"oneOf":[{"type":"string","title":"Source Provider","description":"Detected source provider, for example `supabase` or `vanilla`.","uniqueKey":"source_provider.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source Provider","description":"Detected source provider, for example `supabase` or `vanilla`.","uniqueKey":"source_provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_provider","typeLabel":"string | null"}},"title":"PreflightReport","type":"object","uniqueKey":"","typeLabel":"PreflightReport · object"},"examples":{"Example":{"title":"Example","value":{"branching_prerequisites_pass":true,"checks":{},"grant_script":"\u003cstring>","preflight_pass":true,"source_metadata":{},"source_placement":{},"source_preflight":{},"source_provider":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Preflight hasn't passed for this source; the body is the full preflight report. (A malformed request body also returns 422.)","exampleType":"generated"}},"security":{"6f5a9696-c554-4732-b4b5-3cead6de0568":{"bearerAuth":{"description":"Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.","scheme":"bearer","type":"http","scopes":[]}}},"servers":{"333f0374-1642-430c-9cb3-b30da5f795a0":{"url":"https://api.tryardent.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.","scheme":"bearer","type":"http","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Ardent API key (sk-ard_live_… / sk-ard_test_…) or a dashboard session token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.public.json"},"subdomain":"ardent-48ce3428","siteName":"Ardent","title":"Create a connector - Ardent","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-13T18:55:37.068Z","originalFileLocation":"api/connectors/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Connect a Postgres source to Ardent\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ardent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a connector - Ardent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Connect a Postgres source to Ardent\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ardent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tryardent.com/api/connectors/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ardent-48ce3428.mintlify.app/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Create+a+connector\u0026amp;description=Connect+a+Postgres+source+to+Ardent\u0026amp;theme=6ae3227d4aa15492e260842a\u0026amp;signature=f0cf82d0a91f5ee445980fb6d09bddfe3b4a97fe8c86dc4aac7d80dddf499fe9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a connector - Ardent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Connect a Postgres source to Ardent\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ardent-48ce3428.mintlify.app/_mintlify/api/og/v2?division=Connectors\u0026amp;title=Create+a+connector\u0026amp;description=Connect+a+Postgres+source+to+Ardent\u0026amp;theme=6ae3227d4aa15492e260842a\u0026amp;signature=f0cf82d0a91f5ee445980fb6d09bddfe3b4a97fe8c86dc4aac7d80dddf499fe9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ardent-48ce3428/7WmDvSzlybS5CNlM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ardent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tryardent.com/api/connectors/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/connectors/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tryardent.com/#organization\",\"name\":\"Ardent\",\"url\":\"https://docs.tryardent.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ardent-48ce3428/AH2Rs53EKNDde6Qn/logo/light.svg?fit=max\u0026auto=format\u0026n=AH2Rs53EKNDde6Qn\u0026q=85\u0026s=5fc04448630908a535e6ff2ec3e536f9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tryardent.com#website\",\"name\":\"Ardent\",\"url\":\"https://docs.tryardent.com\",\"publisher\":{\"@id\":\"https://docs.tryardent.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tryardent.com/api/connectors/create#webpage\",\"url\":\"https://docs.tryardent.com/api/connectors/create\",\"name\":\"Create a connector\",\"description\":\"Connect a Postgres source to Ardent\",\"dateModified\":\"2026-07-13T18:55:37.068Z\",\"isPartOf\":{\"@id\":\"https://docs.tryardent.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tryardent.com/api/connectors/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tryardent.com/api/connectors/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Core resources\",\"item\":\"https://docs.tryardent.com/api/projects\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connectors\",\"item\":\"https://docs.tryardent.com/api/connectors\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a connector\",\"item\":\"https://docs.tryardent.com/api/connectors/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tryardent.com/api/connectors/create#apireference\",\"headline\":\"Create a connector\",\"name\":\"Create a connector\",\"description\":\"Connect a Postgres source to Ardent\",\"url\":\"https://docs.tryardent.com/api/connectors/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tryardent.com/api/connectors/create#webpage\"},\"dateModified\":\"2026-07-13T18:55:37.068Z\",\"publisher\":{\"@id\":\"https://docs.tryardent.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tryardent.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ardent\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ardent","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":""}]},{"tab":"CLI reference","icon":"square-terminal","pages":[{"title":"CLI reference","href":"/cli/overview"}]},{"tab":"API reference","icon":"braces","groups":[{"group":"Start here","icon":"sparkles","pages":[{"title":"API overview","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Errors","sidebarTitle":"Errors","href":"/api/errors"}]},{"group":"Core resources","icon":"box","pages":[{"group":"Projects","pages":[{"title":"Projects API","sidebarTitle":"Overview","href":"/api/projects"},{"title":"Create a project","sidebarTitle":"Create project","openapi":"openapi.public.json POST /v1/projects","href":"/api/projects/create"},{"title":"List projects","sidebarTitle":"List projects","openapi":"openapi.public.json GET /v1/projects","href":"/api/projects/list"},{"title":"Get a project","sidebarTitle":"Get project","openapi":"openapi.public.json GET /v1/projects/{project_id}","href":"/api/projects/get"},{"title":"Rename a project","sidebarTitle":"Rename project","openapi":"openapi.public.json PATCH /v1/projects/{project_id}","href":"/api/projects/update"},{"title":"Delete a project","sidebarTitle":"Delete project","openapi":"openapi.public.json DELETE /v1/projects/{project_id}","href":"/api/projects/delete"}]},{"group":"Connectors","pages":[{"title":"Connectors API","sidebarTitle":"Overview","href":"/api/connectors"},{"title":"Preflight a source","sidebarTitle":"Preflight","description":"Check a database before connecting it — creates nothing","openapi":"openapi.public.json POST /v1/connectors/preflight","href":"/api/connectors/preflight"},{"title":"Create a connector","sidebarTitle":"Create","openapi":"openapi.public.json POST /v1/connectors","href":"/api/connectors/create"},{"title":"List connectors","sidebarTitle":"List","description":"List an organization's connectors","openapi":"openapi.public.json GET /v1/connectors","href":"/api/connectors/list"},{"title":"Get a connector","sidebarTitle":"Get","openapi":"openapi.public.json GET /v1/connectors/{connector_id}","href":"/api/connectors/get"},{"title":"Update a connector","sidebarTitle":"Update","openapi":"openapi.public.json PUT /v1/connectors/{connector_id}","href":"/api/connectors/update"},{"title":"Discover schema","sidebarTitle":"Discover","openapi":"openapi.public.json POST /v1/connectors/{connector_id}/discover","href":"/api/connectors/discover"},{"title":"Select databases and schemas","sidebarTitle":"Selection","openapi":"openapi.public.json POST /v1/connectors/{connector_id}/selection","href":"/api/connectors/selection"},{"title":"Submit replica identity decisions","sidebarTitle":"Replica identity","openapi":"openapi.public.json PUT /v1/connectors/{connector_id}/replica-identity-decisions","href":"/api/connectors/replica-identity-decisions"},{"title":"Start setup","sidebarTitle":"Engine setup","openapi":"openapi.public.json POST /v1/connectors/{connector_id}/engine-setup","href":"/api/connectors/engine-setup"},{"title":"Delete a connector","sidebarTitle":"Delete","openapi":"openapi.public.json DELETE /v1/connectors/{connector_id}","href":"/api/connectors/delete"},{"title":"Lock deletion","sidebarTitle":"Lock deletion","openapi":"openapi.public.json POST /v1/connectors/{connector_id}/deletion-lock","href":"/api/connectors/lock"},{"title":"Unlock deletion","sidebarTitle":"Unlock deletion","openapi":"openapi.public.json DELETE /v1/connectors/{connector_id}/deletion-lock","href":"/api/connectors/unlock"},{"title":"List quarantines","sidebarTitle":"List quarantines","openapi":"openapi.public.json GET /v1/connectors/{connector_id}/quarantine","href":"/api/connectors/quarantine-list"},{"title":"Release a quarantine","sidebarTitle":"Release quarantine","openapi":"openapi.public.json POST /v1/connectors/{connector_id}/quarantine/{quarantine_id}/release","href":"/api/connectors/quarantine-release"}]},{"group":"Branches","pages":[{"title":"Branches API","sidebarTitle":"Overview","href":"/api/branches"},{"title":"Create a branch","sidebarTitle":"Create branch","openapi":"openapi.public.json POST /v1/branch/create","href":"/api/branches/create"},{"title":"List branches","sidebarTitle":"List branches","openapi":"openapi.public.json GET /v1/branches/{connector_id}","href":"/api/branches/list"}]},{"title":"Operations API","sidebarTitle":"Operations","openapi":"openapi.public.json GET /v1/operations/{operation_id}","href":"/api/operations"}]},{"group":"Administration","icon":"shield","pages":[{"group":"API keys","pages":[{"title":"API keys API","sidebarTitle":"Overview","href":"/api/api-keys"},{"title":"Create an API key","sidebarTitle":"Create key","openapi":"openapi.public.json POST /v1/orgs/{org_id}/api-keys","href":"/api/api-keys/create"},{"title":"List API keys","sidebarTitle":"List keys","openapi":"openapi.public.json GET /v1/orgs/{org_id}/api-keys","href":"/api/api-keys/list"},{"title":"Revoke an API key","sidebarTitle":"Revoke key","openapi":"openapi.public.json DELETE /v1/orgs/{org_id}/api-keys/{api_key_id}","href":"/api/api-keys/delete"}]},{"title":"Organizations API","sidebarTitle":"Organizations","href":"/api/orgs"}]}]}]},"basePath":"","title":"Create a connector - Ardent","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}