Skip to main content

Drop Collection

Drops a collection. This operation erases your collection data. Exercise caution when performing this operation.


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

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://${CLUSTER_ENDPOINT}/v1/vector/collections/drop" \

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

Possible response is similar to the following.

{
"code": 200,
"data": {}
}

Request

Parameters

  • No query parameters required

  • No path parameters required

  • No header parameters required

Request Body

{
"collectionName": "string"
}
ParameterDescription
collectionNamestring
The name of the collection to delete.

Response

Returns an empty object.

Response Body

{
"code": "integer",
"data": {}
}
PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 0: The request succeeds.
  • Others: Some error occurs.
dataobject

Error Response

{
"code": integer,
"message": string
}
PropertyDescription
codeinteger
Indicates whether the request succeeds.
  • 0: The request succeeds.
  • Others: Some error occurs.
messagestring
Indicates the possible reason for the reported error.