Drop Collection
This operation drops the current collection and all data within the collection.
POST
/v2/vectordb/collections/dropThe base URL for this API is in the following format:
https://${CLUSTER_ENDPOINT}
📘Notes
- You need to fill in
${CLUSTER_ENDPOINT}
with that of your Zilliz Cloud cluster. - To get the endpoint, refer to On Zilliz Cloud Console or use the Describe Cluster V2 API to extract the values from the responses.
export CLUSTER_ENDPOINT=""
Parameters
Authorizationstringheaderrequired
The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password
.
Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring
The name of the database that to which the collection belongs . Setting this to a non-existing database results in an error.
collectionNamestringrequired
The name of the target collection. Setting this to a non-existing collection results in an error.
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "my_collection"
}'
Responses200 - application/json
codeinteger
Response code.
dataobject
Response payload which is an empty object.
Returns an error message.
codeinteger
Response code.
messagestring
Error message.
{
"code": 0,
"data": {}
}