List Collections

Lists collections in a cluster.

---

GET

https://${CLUSTER_ENDPOINT}/v1/vector/collections

---

Example

📘Notes

You can use either of the following ways to authorize:

• An API Key with appropriate permissions.
• A colon-joined username and password of the target cluster. For example, username:passowrd.

export CLUSTER_ENDPOINT="https://inxx-xxxxxxxxxxxxxxx.api.gcp-us-west1.zillizcloud.com:19530"
export TOKEN="db_admin:xxxxxxxxxxx"

curl --location --request POST "http://${CLOUD_ENDPOINT}/v1/vector/collections" \

--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" 

Possible response is similar to the following.

{
    "code": 200,
    "data": [
        "custom_setup_not_indexed",
        "quick_setup",
        "custom_setup_indexed"
    ]
}

Request

Parameters

• No query parameters required

• No path parameters required

• No header parameters required

Request Body

No request body required

Response

Returns a list of collections in the specified cluster.

Response Body

{
    "code": "integer",
    "data": [
        {}
    ]
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
data	array
data[]	string

Error Response

{
    "code": integer,
    "message": string
}

Property	Description
code	integer Indicates whether the request succeeds. 0: The request succeeds. Others: Some error occurs.
message	string Indicates the possible reason for the reported error.