APapinizer
VectorDb

Tests a Vector DB connection

Changed on

Tests a Vector DB connection Manager-side (in-process, does not persist the configuration). Unlike add/update, this does NOT preserve a blank secret from an existing stored connection — the body must carry the full, real transport credentials to test.

post/apiops/projects/{projectName}/vector-dbs/{vectorDbName}/test-connection/

Request

Path parameters

projectNamestring required

Project name

vectorDbNamestring required

Vector DB connection name

Request body

idstring
projectIdstring
namestring
descriptionstring
enabledboolean
projectNamestring
environmentIdstring
circuitBreakerEnabledboolean
errorThresholdValueinteger
sleepWindowinteger
dbType'redis' | 'pgvector' | 'qdrant' | 'weaviate' | 'milvus' | 'chroma' | 'pinecone' | 'other'
defaultCollectionNamestring
embeddingDimensioninteger
distanceMetric'COSINE' | 'EUCLIDEAN' | 'DOT_PRODUCT'
maxBatchSizeinteger
builtInboolean
builtInKeystring
resolvedDefaultCollectionNamestring

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • e083046b24cdRevision changes
    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

    • warning

      removed the request property //////

  • d1a546deccf0Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from object to string

    • breaking

      the request property type changed from object to string

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property type changed from object to no type

    This list may be incomplete.