Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Azure AD access token obtained via MSAL

Path Parameters

id
string
required

Response

Connection copied

Unified data platform connection configuration (databases + vector stores)

id
string
required
name
string
description
string
type
enum<string>

DataPlatformType — database or vector store engine

Available options:
mssql,
postgres,
mysql,
mariadb,
oracle,
db2,
sqlite,
supabase,
hana,
duckdb,
databricks,
snowflake,
redshift,
synapse,
fabric-warehouse,
fabric-lakehouse,
athena,
bigquery,
clickhouse,
trino,
adx,
cosmosdb,
mongodb,
dynamodb,
cassandra,
couchdb,
firebase,
pinecone,
weaviate,
qdrant,
chroma,
elasticsearch,
opensearch,
pgvector,
redis,
milvus,
mongodb_atlas,
vertex_ai_search,
aws_kendra,
oracle_vector,
vespa,
lancedb,
marqo
scope
enum<string>
Available options:
personal,
shared
isPublic
boolean
owners
object[]
contributors
object[]
users
object[]
inheritEntitlements
endpoint
string

Hostname, URL, or workspace URL

port
integer
database
string

Database / catalog / project name

cloudProvider
enum<string>
Available options:
aws,
azure,
gcp
region
string

AWS/Azure/GCP region

workspace
string

Databricks workspace ID

warehouse
string

Snowflake warehouse / Databricks SQL warehouse

httpPath
string

Databricks HTTP path

catalog
string

Unity Catalog / BigQuery dataset

schema
string

Default schema

s3OutputLocation
string

Athena results S3 location

authentication
object
index
string

Index / collection / class name for vector stores

namespace
string

Namespace / partition (Pinecone namespace, Redis prefix)

ssl
boolean
verifySSL
boolean

Verify SSL certificates (default: true)

timeout
integer

Connection timeout in milliseconds

maxRetries
integer
connectionString
string

Full connection string (alternative to individual fields)

isEnabled
boolean
createdBy
string
createdAt
string
updatedAt
string
tags
string[]