Milvus REST API
Browse 113 operations in 17 categories for Milvus 3.0.6. Open an operation to inspect its parameters and send a request to your cluster.
Entities & search8 operations
- Insert entities
/v2/vectordb/entities/insert - Upsert entities
/v2/vectordb/entities/upsert - Get by ID
/v2/vectordb/entities/get - Query entities
/v2/vectordb/entities/query - Search vectors
/v2/vectordb/entities/search - Hybrid search
/v2/vectordb/entities/hybrid_search - Advanced search (alias)
/v2/vectordb/entities/advanced_search - Delete entities
/v2/vectordb/entities/delete
Collections17 operations
- List collections
/v2/vectordb/collections/list - Create collection
/v2/vectordb/collections/create - Check collection existence
/v2/vectordb/collections/has - Describe collection
/v2/vectordb/collections/describe - Collection statistics
/v2/vectordb/collections/get_stats - Load collection
/v2/vectordb/collections/load - Get load state
/v2/vectordb/collections/get_load_state - Refresh loaded data
/v2/vectordb/collections/refresh_load - Release collection
/v2/vectordb/collections/release - Rename collection
/v2/vectordb/collections/rename - Set properties
/v2/vectordb/collections/alter_properties - Remove properties
/v2/vectordb/collections/drop_properties - Flush collection
/v2/vectordb/collections/flush - Start compaction
/v2/vectordb/collections/compact - Get compaction state
/v2/vectordb/collections/get_compaction_state - Truncate collection
/v2/vectordb/collections/truncate - Drop collection
/v2/vectordb/collections/drop
Fields & functions9 operations
- Add field
/v2/vectordb/collections/fields/add - Add struct field
/v2/vectordb/collections/struct_fields/add - Set field properties
/v2/vectordb/collections/fields/alter_properties - Drop field
/v2/vectordb/collections/fields/drop - Add function (legacy)
/v2/vectordb/collections/add_function - Alter function
/v2/vectordb/collections/alter_function - Drop function (legacy)
/v2/vectordb/collections/drop_function - Add function and field
/v2/vectordb/collections/add_function_field - Drop function and field
/v2/vectordb/collections/drop_function_field
Indexes6 operations
- List indexes
/v2/vectordb/indexes/list - Create index
/v2/vectordb/indexes/create - Describe index
/v2/vectordb/indexes/describe - Set index properties
/v2/vectordb/indexes/alter_properties - Remove index properties
/v2/vectordb/indexes/drop_properties - Drop index
/v2/vectordb/indexes/drop
Partitions7 operations
- List partitions
/v2/vectordb/partitions/list - Create partition
/v2/vectordb/partitions/create - Check partition existence
/v2/vectordb/partitions/has - Partition statistics
/v2/vectordb/partitions/get_stats - Load partitions
/v2/vectordb/partitions/load - Release partitions
/v2/vectordb/partitions/release - Drop partition
/v2/vectordb/partitions/drop
Databases7 operations
- List databases
/v2/vectordb/databases/list - Create database
/v2/vectordb/databases/create - Describe database
/v2/vectordb/databases/describe - Set database properties
/v2/vectordb/databases/alter_properties - Alter database
/v2/vectordb/databases/alter - Remove database properties
/v2/vectordb/databases/drop_properties - Drop database
/v2/vectordb/databases/drop
Collection aliases5 operations
- List aliases
/v2/vectordb/aliases/list - Create alias
/v2/vectordb/aliases/create - Describe alias
/v2/vectordb/aliases/describe - Reassign alias
/v2/vectordb/aliases/alter - Drop alias
/v2/vectordb/aliases/drop
Bulk import6 operations
- Start import
/v2/vectordb/jobs/import/create - List import jobs
/v2/vectordb/jobs/import/list - Describe import job
/v2/vectordb/jobs/import/describe - Get progress (legacy)
/v2/vectordb/jobs/import/get_progress - Commit import
/v2/vectordb/jobs/import/commit - Abort import
/v2/vectordb/jobs/import/abort
External collections3 operations
- Refresh external collection
/v2/vectordb/jobs/external_collection/refresh - List refresh jobs
/v2/vectordb/jobs/external_collection/list - Describe refresh job
/v2/vectordb/jobs/external_collection/describe
Collection snapshots7 operations
- Create snapshot
/v2/vectordb/snapshots/create - List snapshots
/v2/vectordb/snapshots/list - Describe snapshot
/v2/vectordb/snapshots/describe - Restore snapshot
/v2/vectordb/snapshots/restore - Pin snapshot data
/v2/vectordb/snapshots/pin - Unpin snapshot data
/v2/vectordb/snapshots/unpin - Drop snapshot
/v2/vectordb/snapshots/drop
Snapshot jobs5 operations
- List restore jobs
/v2/vectordb/jobs/snapshot/list - Describe restore job
/v2/vectordb/jobs/snapshot/describe - Export snapshot
/v2/vectordb/jobs/snapshot/export - Describe export job
/v2/vectordb/jobs/snapshot/export/describe - Restore external snapshot
/v2/vectordb/jobs/snapshot/restore_external
Users7 operations
- List users
/v2/vectordb/users/list - Create user
/v2/vectordb/users/create - Describe user
/v2/vectordb/users/describe - Update user
/v2/vectordb/users/update_password - Assign role
/v2/vectordb/users/grant_role - Revoke role
/v2/vectordb/users/revoke_role - Drop user
/v2/vectordb/users/drop
Roles & grants9 operations
- List roles
/v2/vectordb/roles/list - Create role
/v2/vectordb/roles/create - Describe role
/v2/vectordb/roles/describe - Alter role
/v2/vectordb/roles/alter - Grant privilege
/v2/vectordb/roles/grant_privilege_v2 - Revoke privilege
/v2/vectordb/roles/revoke_privilege_v2 - Grant on object (legacy)
/v2/vectordb/roles/grant_privilege - Revoke on object (legacy)
/v2/vectordb/roles/revoke_privilege - Drop role
/v2/vectordb/roles/drop
Privilege groups5 operations
- List privilege groups
/v2/vectordb/privilege_groups/list - Create privilege group
/v2/vectordb/privilege_groups/create - Add privileges
/v2/vectordb/privilege_groups/add_privileges_to_group - Remove privileges
/v2/vectordb/privilege_groups/remove_privileges_from_group - Drop privilege group
/v2/vectordb/privilege_groups/drop
Resource groups6 operations
- List resource groups
/v2/vectordb/resource_groups/list - Create resource group
/v2/vectordb/resource_groups/create - Describe resource group
/v2/vectordb/resource_groups/describe - Update resource groups
/v2/vectordb/resource_groups/alter - Transfer replicas
/v2/vectordb/resource_groups/transfer_replica - Drop resource group
/v2/vectordb/resource_groups/drop
Text analysis & files4 operations
- Run text analyzer
/v2/vectordb/common/run_analyzer - Register file resource
/v2/vectordb/file_resources/add - List file resources
/v2/vectordb/file_resources/list - Remove file resource
/v2/vectordb/file_resources/remove
Diagnostics2 operations
- Describe segments
/v2/vectordb/segments/describe - Describe quota metrics
/v2/vectordb/quotacenter/describe