# Milvus REST API

Browse the Milvus REST v2 API and send requests directly to your cluster.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/

## Section links

- [Entities & search](https://milvus-io.github.io/milvus-sdk-node/rest-api/#entities)
- [Collections](https://milvus-io.github.io/milvus-sdk-node/rest-api/#collections)
- [Fields & functions](https://milvus-io.github.io/milvus-sdk-node/rest-api/#schema)
- [Indexes](https://milvus-io.github.io/milvus-sdk-node/rest-api/#indexes)
- [Partitions](https://milvus-io.github.io/milvus-sdk-node/rest-api/#partitions)
- [Databases](https://milvus-io.github.io/milvus-sdk-node/rest-api/#databases)
- [Collection aliases](https://milvus-io.github.io/milvus-sdk-node/rest-api/#aliases)
- [Bulk import](https://milvus-io.github.io/milvus-sdk-node/rest-api/#import-jobs)
- [External collections](https://milvus-io.github.io/milvus-sdk-node/rest-api/#external-collections)
- [Collection snapshots](https://milvus-io.github.io/milvus-sdk-node/rest-api/#snapshots)
- [Snapshot jobs](https://milvus-io.github.io/milvus-sdk-node/rest-api/#snapshot-jobs)
- [Users](https://milvus-io.github.io/milvus-sdk-node/rest-api/#users)
- [Roles & grants](https://milvus-io.github.io/milvus-sdk-node/rest-api/#roles)
- [Privilege groups](https://milvus-io.github.io/milvus-sdk-node/rest-api/#privilege-groups)
- [Resource groups](https://milvus-io.github.io/milvus-sdk-node/rest-api/#resource-groups)
- [Text analysis & files](https://milvus-io.github.io/milvus-sdk-node/rest-api/#text-analysis)
- [Diagnostics](https://milvus-io.github.io/milvus-sdk-node/rest-api/#diagnostics)

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 & search

- [Insert entities](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/insert/) `/v2/vectordb/entities/insert`
- [Upsert entities](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/upsert/) `/v2/vectordb/entities/upsert`
- [Get by ID](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/get/) `/v2/vectordb/entities/get`
- [Query entities](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/query/) `/v2/vectordb/entities/query`
- [Search vectors](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/search/) `/v2/vectordb/entities/search`
- [Hybrid search](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/hybrid-search/) `/v2/vectordb/entities/hybrid_search`
- [Advanced search (alias)](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/advanced-search/) `/v2/vectordb/entities/advanced_search`
- [Delete entities](https://milvus-io.github.io/milvus-sdk-node/rest-api/entities/delete/) `/v2/vectordb/entities/delete`

## Collections

- [List collections](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/list/) `/v2/vectordb/collections/list`
- [Create collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/create/) `/v2/vectordb/collections/create`
- [Check collection existence](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/has/) `/v2/vectordb/collections/has`
- [Describe collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/describe/) `/v2/vectordb/collections/describe`
- [Collection statistics](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/get-stats/) `/v2/vectordb/collections/get_stats`
- [Load collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/load/) `/v2/vectordb/collections/load`
- [Get load state](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/get-load-state/) `/v2/vectordb/collections/get_load_state`
- [Refresh loaded data](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/refresh-load/) `/v2/vectordb/collections/refresh_load`
- [Release collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/release/) `/v2/vectordb/collections/release`
- [Rename collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/rename/) `/v2/vectordb/collections/rename`
- [Set properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/alter-properties/) `/v2/vectordb/collections/alter_properties`
- [Remove properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/drop-properties/) `/v2/vectordb/collections/drop_properties`
- [Flush collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/flush/) `/v2/vectordb/collections/flush`
- [Start compaction](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/compact/) `/v2/vectordb/collections/compact`
- [Get compaction state](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/get-compaction-state/) `/v2/vectordb/collections/get_compaction_state`
- [Truncate collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/truncate/) `/v2/vectordb/collections/truncate`
- [Drop collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/collections/drop/) `/v2/vectordb/collections/drop`

## Fields & functions

- [Add field](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/fields/add/) `/v2/vectordb/collections/fields/add`
- [Add struct field](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/struct-fields/add/) `/v2/vectordb/collections/struct_fields/add`
- [Set field properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/fields/alter-properties/) `/v2/vectordb/collections/fields/alter_properties`
- [Drop field](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/fields/drop/) `/v2/vectordb/collections/fields/drop`
- [Add function (legacy)](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/add-function/) `/v2/vectordb/collections/add_function`
- [Alter function](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/alter-function/) `/v2/vectordb/collections/alter_function`
- [Drop function (legacy)](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/drop-function/) `/v2/vectordb/collections/drop_function`
- [Add function and field](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/add-function-field/) `/v2/vectordb/collections/add_function_field`
- [Drop function and field](https://milvus-io.github.io/milvus-sdk-node/rest-api/schema/drop-function-field/) `/v2/vectordb/collections/drop_function_field`

## Indexes

- [List indexes](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/list/) `/v2/vectordb/indexes/list`
- [Create index](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/create/) `/v2/vectordb/indexes/create`
- [Describe index](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/describe/) `/v2/vectordb/indexes/describe`
- [Set index properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/alter-properties/) `/v2/vectordb/indexes/alter_properties`
- [Remove index properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/drop-properties/) `/v2/vectordb/indexes/drop_properties`
- [Drop index](https://milvus-io.github.io/milvus-sdk-node/rest-api/indexes/drop/) `/v2/vectordb/indexes/drop`

## Partitions

- [List partitions](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/list/) `/v2/vectordb/partitions/list`
- [Create partition](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/create/) `/v2/vectordb/partitions/create`
- [Check partition existence](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/has/) `/v2/vectordb/partitions/has`
- [Partition statistics](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/get-stats/) `/v2/vectordb/partitions/get_stats`
- [Load partitions](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/load/) `/v2/vectordb/partitions/load`
- [Release partitions](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/release/) `/v2/vectordb/partitions/release`
- [Drop partition](https://milvus-io.github.io/milvus-sdk-node/rest-api/partitions/drop/) `/v2/vectordb/partitions/drop`

## Databases

- [List databases](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/list/) `/v2/vectordb/databases/list`
- [Create database](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/create/) `/v2/vectordb/databases/create`
- [Describe database](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/describe/) `/v2/vectordb/databases/describe`
- [Set database properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/alter-properties/) `/v2/vectordb/databases/alter_properties`
- [Alter database](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/alter/) `/v2/vectordb/databases/alter`
- [Remove database properties](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/drop-properties/) `/v2/vectordb/databases/drop_properties`
- [Drop database](https://milvus-io.github.io/milvus-sdk-node/rest-api/databases/drop/) `/v2/vectordb/databases/drop`

## Collection aliases

- [List aliases](https://milvus-io.github.io/milvus-sdk-node/rest-api/aliases/list/) `/v2/vectordb/aliases/list`
- [Create alias](https://milvus-io.github.io/milvus-sdk-node/rest-api/aliases/create/) `/v2/vectordb/aliases/create`
- [Describe alias](https://milvus-io.github.io/milvus-sdk-node/rest-api/aliases/describe/) `/v2/vectordb/aliases/describe`
- [Reassign alias](https://milvus-io.github.io/milvus-sdk-node/rest-api/aliases/alter/) `/v2/vectordb/aliases/alter`
- [Drop alias](https://milvus-io.github.io/milvus-sdk-node/rest-api/aliases/drop/) `/v2/vectordb/aliases/drop`

## Bulk import

- [Start import](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/create/) `/v2/vectordb/jobs/import/create`
- [List import jobs](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/list/) `/v2/vectordb/jobs/import/list`
- [Describe import job](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/describe/) `/v2/vectordb/jobs/import/describe`
- [Get progress (legacy)](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/get-progress/) `/v2/vectordb/jobs/import/get_progress`
- [Commit import](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/commit/) `/v2/vectordb/jobs/import/commit`
- [Abort import](https://milvus-io.github.io/milvus-sdk-node/rest-api/import-jobs/abort/) `/v2/vectordb/jobs/import/abort`

## External collections

- [Refresh external collection](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/refresh/) `/v2/vectordb/jobs/external_collection/refresh`
- [List refresh jobs](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/list/) `/v2/vectordb/jobs/external_collection/list`
- [Describe refresh job](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/) `/v2/vectordb/jobs/external_collection/describe`

## Collection snapshots

- [Create snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/create/) `/v2/vectordb/snapshots/create`
- [List snapshots](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/list/) `/v2/vectordb/snapshots/list`
- [Describe snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/describe/) `/v2/vectordb/snapshots/describe`
- [Restore snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/restore/) `/v2/vectordb/snapshots/restore`
- [Pin snapshot data](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/pin/) `/v2/vectordb/snapshots/pin`
- [Unpin snapshot data](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/unpin/) `/v2/vectordb/snapshots/unpin`
- [Drop snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshots/drop/) `/v2/vectordb/snapshots/drop`

## Snapshot jobs

- [List restore jobs](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshot-jobs/list/) `/v2/vectordb/jobs/snapshot/list`
- [Describe restore job](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshot-jobs/describe/) `/v2/vectordb/jobs/snapshot/describe`
- [Export snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshot-jobs/export/) `/v2/vectordb/jobs/snapshot/export`
- [Describe export job](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshot-jobs/export/describe/) `/v2/vectordb/jobs/snapshot/export/describe`
- [Restore external snapshot](https://milvus-io.github.io/milvus-sdk-node/rest-api/snapshot-jobs/restore-external/) `/v2/vectordb/jobs/snapshot/restore_external`

## Users

- [List users](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/list/) `/v2/vectordb/users/list`
- [Create user](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/create/) `/v2/vectordb/users/create`
- [Describe user](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/describe/) `/v2/vectordb/users/describe`
- [Update user](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/update-password/) `/v2/vectordb/users/update_password`
- [Assign role](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/grant-role/) `/v2/vectordb/users/grant_role`
- [Revoke role](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/revoke-role/) `/v2/vectordb/users/revoke_role`
- [Drop user](https://milvus-io.github.io/milvus-sdk-node/rest-api/users/drop/) `/v2/vectordb/users/drop`

## Roles & grants

- [List roles](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/list/) `/v2/vectordb/roles/list`
- [Create role](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/create/) `/v2/vectordb/roles/create`
- [Describe role](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/describe/) `/v2/vectordb/roles/describe`
- [Alter role](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/alter/) `/v2/vectordb/roles/alter`
- [Grant privilege](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/grant-privilege-v2/) `/v2/vectordb/roles/grant_privilege_v2`
- [Revoke privilege](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/revoke-privilege-v2/) `/v2/vectordb/roles/revoke_privilege_v2`
- [Grant on object (legacy)](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/grant-privilege/) `/v2/vectordb/roles/grant_privilege`
- [Revoke on object (legacy)](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/revoke-privilege/) `/v2/vectordb/roles/revoke_privilege`
- [Drop role](https://milvus-io.github.io/milvus-sdk-node/rest-api/roles/drop/) `/v2/vectordb/roles/drop`

## Privilege groups

- [List privilege groups](https://milvus-io.github.io/milvus-sdk-node/rest-api/privilege-groups/list/) `/v2/vectordb/privilege_groups/list`
- [Create privilege group](https://milvus-io.github.io/milvus-sdk-node/rest-api/privilege-groups/create/) `/v2/vectordb/privilege_groups/create`
- [Add privileges](https://milvus-io.github.io/milvus-sdk-node/rest-api/privilege-groups/add-privileges-to-group/) `/v2/vectordb/privilege_groups/add_privileges_to_group`
- [Remove privileges](https://milvus-io.github.io/milvus-sdk-node/rest-api/privilege-groups/remove-privileges-from-group/) `/v2/vectordb/privilege_groups/remove_privileges_from_group`
- [Drop privilege group](https://milvus-io.github.io/milvus-sdk-node/rest-api/privilege-groups/drop/) `/v2/vectordb/privilege_groups/drop`

## Resource groups

- [List resource groups](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/list/) `/v2/vectordb/resource_groups/list`
- [Create resource group](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/create/) `/v2/vectordb/resource_groups/create`
- [Describe resource group](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/describe/) `/v2/vectordb/resource_groups/describe`
- [Update resource groups](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/alter/) `/v2/vectordb/resource_groups/alter`
- [Transfer replicas](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/transfer-replica/) `/v2/vectordb/resource_groups/transfer_replica`
- [Drop resource group](https://milvus-io.github.io/milvus-sdk-node/rest-api/resource-groups/drop/) `/v2/vectordb/resource_groups/drop`

## Text analysis & files

- [Run text analyzer](https://milvus-io.github.io/milvus-sdk-node/rest-api/text-analysis/common/run-analyzer/) `/v2/vectordb/common/run_analyzer`
- [Register file resource](https://milvus-io.github.io/milvus-sdk-node/rest-api/text-analysis/file-resources/add/) `/v2/vectordb/file_resources/add`
- [List file resources](https://milvus-io.github.io/milvus-sdk-node/rest-api/text-analysis/file-resources/list/) `/v2/vectordb/file_resources/list`
- [Remove file resource](https://milvus-io.github.io/milvus-sdk-node/rest-api/text-analysis/file-resources/remove/) `/v2/vectordb/file_resources/remove`

## Diagnostics

- [Describe segments](https://milvus-io.github.io/milvus-sdk-node/rest-api/diagnostics/segments/describe/) `/v2/vectordb/segments/describe`
- [Describe quota metrics](https://milvus-io.github.io/milvus-sdk-node/rest-api/diagnostics/quotacenter/describe/) `/v2/vectordb/quotacenter/describe`
