---
title: "Add a Vector DB connection to specified project"
method: POST
path: "/apiops/projects/{projectName}/vector-dbs/{vectorDbName}/"
tags: ["VectorDb"]
---

# Add a Vector DB connection to specified project

`POST /apiops/projects/{projectName}/vector-dbs/{vectorDbName}/`

## Request

- Base URL: `http://167.86.118.166:32080`
- URL: `http://167.86.118.166:32080/apiops/projects/{projectName}/vector-dbs/{vectorDbName}/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/apinizer/apis/apinizer-management-apis/docs/apiops/projects/:projectName/vector-dbs/:vectorDbName/post.ts> (a function with typed inputs; its response is checked against the schema)

Adds a Vector DB connection to specified project. If a connection with the same name exists, it is updated (upsert).

## Path parameters

- `projectName` string, required
- `vectorDbName` string, required

## Request body

- ConnectionConfigVectorDb: Vector DB connection value to be added. The internal '_class' discriminator is optional — it is derived automatically when omitted.
  - `id` string
  - `projectId` string
  - `name` string
  - `description` string
  - `enabled` boolean
  - `projectName` string
  - `environmentId` string
  - `circuitBreakerEnabled` boolean
  - `errorThresholdValue` integer
  - `sleepWindow` integer
  - `dbType` 'redis' | 'pgvector' | 'qdrant' | 'weaviate' | 'milvus' | 'chroma' | 'pinecone' | 'other'
  - `transport` union
    - HttpTransport
      - `connectTimeoutMs` integer
      - `requestTimeoutMs` integer
      - `family` string, required
      - `endpoint` string
      - `apiVersion` string
      - `authScheme` 'BEARER' | 'API_KEY_HEADER' | 'BASIC' | 'AWS_SIGV4' | 'OAUTH2' | 'NONE' | 'CUSTOM'
      - `authHeaderName` string
      - `apiKey` string
      - `apiSecret` string
      - `regionCode` string
      - `resolvedRegionCode` string
      - `resolvedEndpoint` string
      - `resolvedApiVersion` string
      - `resolvedAuthHeaderName` string
    - JdbcTransport
      - `connectTimeoutMs` integer
      - `requestTimeoutMs` integer
      - `family` string, required
      - `jdbcUrl` string
      - `username` string
      - `password` string
      - `schema` string
      - `pool` PoolSettings
        - `minimumIdle` integer
        - `maximumPoolSize` integer
        - `connectionTimeoutMs` integer
        - `idleTimeoutMs` integer
        - `maxLifetimeMs` integer
      - `resolvedUsername` string
      - `resolvedJdbcUrl` string
      - `resolvedSchema` string
    - RedisTransport
      - `connectTimeoutMs` integer
      - `requestTimeoutMs` integer
      - `family` string, required
      - `uri` string
      - `username` string
      - `password` string
      - `resolvedUsername` string
      - `resolvedUri` string
  - `defaultCollectionName` string
  - `embeddingDimension` integer
  - `distanceMetric` 'COSINE' | 'EUCLIDEAN' | 'DOT_PRODUCT'
  - `maxBatchSize` integer
  - `builtIn` boolean
  - `builtInKey` string
  - `resolvedDefaultCollectionName` string

## Response `200`

successful operation!

- ApiOpsResponseSuccess
  - `status` 'SUCCESS' | 'FAILURE'
  - `resultMessage` string
  - `resultList` string[]
  - `resultCount` integer
  - `deploymentResult` DeploymentResult
    - `envName` string
    - `podName` string
    - `podIp` string
    - `success` boolean
    - `detail` string
    - `responseTime` integer
    - `detailList` unknown[]
      - unknown
    - `firstFromApiResultList` unknown
  - `unresolvedReferences` string[]
  - `advisories` ApiOpsAdvisoryDTO[]
    - `level` string
    - `key` string
    - `params` object

## Other responses

- `401`: not authorized for this operation!
- `500`: internal error!

## Changes

- **2026-10-28** `e083046b24cd`: 4 warning
  - removed the request property `transport/oneOf[#/components/schemas/HttpTransport]/allOf[subschema #2]/resolvedApiKey`
  - removed the request property `transport/oneOf[#/components/schemas/HttpTransport]/allOf[subschema #2]/resolvedApiSecret`
  - removed the request property `transport/oneOf[#/components/schemas/JdbcTransport]/allOf[subschema #2]/resolvedPassword`
  - removed the request property `transport/oneOf[#/components/schemas/RedisTransport]/allOf[subschema #2]/resolvedPassword`
- **2026-08-11** `9ae232e55479`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/apinizer/apis/apinizer-management-apis/changes/apiops/projects/:projectName/vector-dbs/:vectorDbName/post.md)

---

[API](https://skmtc.dev/apinizer/apis/apinizer-management-apis.md) - [All operations](https://skmtc.dev/apinizer/apis/apinizer-management-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/apinizer/apis/apinizer-management-apis/revisions/e083046b24cd?raw)