RESTful

List Collections

This operation lists all collection names.

POST

/v2/vectordb/collections/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 an existing database.

export TOKEN="root:Milvus"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/list" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "_default"
}'

Responses200 - application/json

SUCCESS

codeinteger

Response code.

dataarray

Response payload which is a list of collection names.

[]datastring

A collection name.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": [
        "quick_setup_new",
        "customized_setup_1",
        "customized_setup_2"
    ]
}