VBase API Reference
Last validated: 2026-05-11
This API reference is now split by domain so you can find details faster.
Validated sources:
dodil-vbase/proto/proto-vbase/vbase.protododil-vbase/server/src/grpc/vbase_grpc_service.rsdodil-vbase/server/src/grpc/vbase_admin_grpc_service.rsdodil-vbase/server/src/infrastructure/milvus/milvus_operations.rs
Read by Domain
- Protocols, Auth, and Conventions
- gRPC vs HTTP gateway model, headers, response envelope, status model, and baseline examples.
- Service Lifecycle APIs
- Health, dedicated cluster lifecycle, shared database lifecycle, and service discovery/access APIs.
- Backup and Policy APIs
- Backup, restore, list/delete backup artifacts, and backup policy lifecycle.
- RunCommand Milvus Bridge
- Generic Milvus method execution through VBase with payload/metadata guidance.
- Admin API and Drift Notes
- Internal admin endpoints, known annotation drift, and compatibility guidance.
Service Inventory
dodil.vbase.v1.VBaseServicedodil.vbase.v1.VBaseAdminService
Quick Navigation by Task
- I need to allocate/delete a shared database: see Service Lifecycle APIs.
- I need cluster create/scale/delete for dedicated mode: see Service Lifecycle APIs.
- I need backup/restore: see Backup and Policy APIs.
- I need a Milvus operation not exposed by CLI: see RunCommand Milvus Bridge.
- I need to understand gateway/proto drift: see Admin API and Drift Notes.