milvus-logo
LFAI
< Docs
  • RESTful
    • v2

List Indexes

This operation lists all indexes of a specific collection.

POST
/v2/vectordb/indexes/list
Cluster Endpoint

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database to which the collection belongs.

collectionNamestringrequired

The name of an existing collection. Setting this to a non-existing collection leads to an error.

export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/indexes/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection"
}'
Responses200 - application/json

A success response.

codeinteger

Response code.

Example Value: 0
dataarray

Response payload which is a list of indexes.

[]datastring

An index name.

A failure response.

codeinteger

Response code.

messagestring

Error message.

{
"code": 0,
"data": [
"my_vector_index"
]
}