Get VectorDB Connection

Endpoint

GET /apiops/projects/{projectName}/vector-dbs/{vectorDbName}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
vectorDbName	string	Yes	Vector DB connection name

Query Parameters

None

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "resultList": [
    {
      "id": "6634f1a2b8c1e2f3a4b5c6d7",
      "projectId": "6634aaaa0000000000000001",
      "projectName": "MyProject",
      "name": "pgvector-primary",
      "description": "Primary pgvector store for RAG",
      "enabled": true,
      "dbType": "PGVECTOR",
      "family": "jdbc",
      "connectTimeoutMs": 5000,
      "requestTimeoutMs": 30000,
      "jdbcUrl": "jdbc:postgresql://db.internal:5432/vectors",
      "jdbcUsername": "apinizer",
      "jdbcPasswordSet": true,
      "poolMinimumIdle": 2,
      "poolMaximumPoolSize": 5,
      "poolConnectionTimeoutMs": 30000,
      "poolIdleTimeoutMs": 600000,
      "poolMaxLifetimeMs": 1800000,
      "defaultCollectionName": "documents",
      "embeddingDimension": 1536,
      "distanceMetric": "COSINE",
      "maxBatchSize": 100,
      "builtIn": false
    }
  ],
  "resultCount": 1
}

Response Fields

Field	Type	Description
status	string	Response status: SUCCESS or FAILURE
resultList	array	Single-element array with the matching connection object
resultCount	integer	Number of connections returned (1 on success)

Vector DB Connection Object Fields

The object is a flattened view: common fields, then the transport fields for the connection's family. Fields not belonging to the active family are omitted.

Field	Type	Description
id	string	Connection id (read-only)
projectId	string	Owning project id
projectName	string	Owning project name
name	string	Connection name (unique within the project)
description	string	Free-text description
enabled	boolean	Whether the connection is enabled
dbType	enum	Vector store type: PGVECTOR, QDRANT, WEAVIATE, MILVUS, CHROMA, PINECONE, REDIS, OTHER
family	string	Transport family selected by dbType: jdbc, http or redis
connectTimeoutMs	integer	Transport connect timeout (ms)
requestTimeoutMs	integer	Transport request/command timeout (ms)
jdbcUrl	string	(family jdbc) JDBC URL, e.g. jdbc:postgresql://host:port/db
jdbcUsername	string	(family jdbc) Database username
jdbcPasswordSet	boolean	(family jdbc) true if a password is stored — the plaintext is never returned
poolMinimumIdle	integer	(family jdbc) HikariCP minimum idle connections
poolMaximumPoolSize	integer	(family jdbc) HikariCP maximum pool size
poolConnectionTimeoutMs	integer	(family jdbc) HikariCP connection timeout (ms)
poolIdleTimeoutMs	integer	(family jdbc) HikariCP idle timeout (ms)
poolMaxLifetimeMs	integer	(family jdbc) HikariCP max lifetime (ms)
endpoint	string	(family http) REST endpoint URL
apiVersion	string	(family http) Vendor API version
authScheme	enum	(family http) Auth scheme: BEARER, API_KEY_HEADER, BASIC, NONE, CUSTOM
authHeaderName	string	(family http) Header name for API-key auth
apiKeySet	boolean	(family http) true if an apiKey is stored — plaintext never returned
apiSecretSet	boolean	(family http) true if an apiSecret is stored — plaintext never returned
regionCode	string	(family http) Vendor region code (e.g. Pinecone)
redisUri	string	(family redis) Redis URI (redis:// / rediss://)
redisUsername	string	(family redis) Redis ACL username
redisPasswordSet	boolean	(family redis) true if a password is stored — plaintext never returned
defaultCollectionName	string	Default collection / index / table name
embeddingDimension	integer	Embedding vector dimension (e.g. 1536)
distanceMetric	enum	Distance metric: COSINE, EUCLIDEAN, DOT_PRODUCT
maxBatchSize	integer	Maximum upsert/query batch size
builtIn	boolean	true for system-provided built-in templates, false for user-created connections.

EnumStatus

• SUCCESS - Operation successful
• FAILURE - Operation failed

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Vector DB connection (name: pgvector-primary) was not found!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "Vector DB connection name can not be empty!"
}

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/vector-dbs/pgvector-primary/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Masked Secrets: The JDBC password, HTTP apiKey/apiSecret and Redis password are never returned — only boolean presence flags (jdbcPasswordSet, apiKeySet, apiSecretSet, redisPasswordSet).
• Single-element Result: On success the connection is wrapped in a one-element resultList (same envelope as the list endpoint), not returned bare.
• Name-based: The lookup is a case-insensitive exact match on name within the project.
• Not Found: A non-existent name returns 400 Bad Request with status: FAILURE.

Related Documentation

• List VectorDB Connections - List all connections in a project
• Update VectorDB Connection - Update an existing connection
• VectorDB Connections API - Resource overview
• AI Gateway API - Full AI Gateway APIops surface