Skip to main content

Delete (V1)

Deprecated
Notes

This endpoint is deprecated. Please consider using the corresponding V2 endpoint instead.

Deletes one or more entities from a collection.

POST/v1/vector/delete
Connection Endpoint

The 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, use the Describe Cluster API to extract the values from the responses.
shell
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.

collectionNamestringrequired

The name of the collection to which this operation applies.

idoneOfrequired

The primary key of the entity to delete. Use this parameter instead of filter to delete a single entity by its ID.

string

The ID of the entity to be deleted

An array of IDs of the entities to be deleted

integer

The ID of the entity to be deleted

An array of IDs of the entities to be deleted

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/delete" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "dbName": "default",
    "collectionName": "my_collection",
    "id": "4321034832910"
}'
bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/delete" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "collectionName": "my_collection",
    "id": [
        4321034832910,
        4321034832911
    ]
}'
Responses200 OK - application/json

Returns an empty object.

An object returned when the delete operation succeeds.

codeinteger

Response code.

dataobject

Response payload which is an empty object.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

Successjson
{
    "code": 200,
    "data": {}
}
Ctrl I