VectorDB Connections API

Endpoints

• List VectorDB Connections - List all Vector DB connections in a project
• Get VectorDB Connection - Get a single Vector DB connection by name
• Create VectorDB Connection - Create (or upsert) a Vector DB connection
• Update VectorDB Connection - Update an existing Vector DB connection
• Delete VectorDB Connection - Delete a Vector DB connection and undeploy it
• Test VectorDB Connection - Test connectivity without persisting

Authentication

All endpoints require authentication using a Personal API Access Token (Authorization: Bearer {token}). JHipster JWTs do not work on APIops.

Permissions

• AI_DEVELOPMENT asset category — VIEW for reads (GET), MANAGE for writes (POST / PUT / DELETE / test-connection)

Key Concepts

• Name-based — connections are referenced by name, never by runtime id. POST /{vectorDbName}/ is an upsert: it creates the connection, or updates it in place if the name already exists in the project.
• Polymorphic transport — the connection type discriminator is _class: "vector-db" at the top level; the connection details live in a nested transport sub-document whose own family discriminator (jdbc / http / redis) is chosen by dbType.
• Secret masking on read — the JDBC password, HTTP apiKey/apiSecret and Redis password are never returned. Read responses expose only boolean presence flags (jdbcPasswordSet, apiKeySet, apiSecretSet, redisPasswordSet).
• Blank-secret preserve on update — sending a blank secret on PUT keeps the stored value (INV-06).

Related Documentation

• AI Gateway API - Full AI Gateway APIops surface
• Authentication Guide - How to obtain and use API tokens
• Error Handling - Error response formats