Skip to main content

Delete Volume (V2)

This operation deletes a volume in the specified project.

DELETE
/v2/volumes/{VOLUME_NAME}
Cluster 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 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}}
VOLUME_NAMEstringpathrequired

The name of an existing volume to delete.

Example Value: my_volume
export TOKEN="db_admin:xxxxxxxxxxxxx"
export VOLUME_NAME="my_volume"

curl --request DELETE \
--url "${CLUSTER_ENDPOINT}/v2/volumes/${VOLUME_NAME}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json

Returns a list of volumes.

codeinteger

Response code.

dataobject
volumeNamestring

The name of the created volume.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "volumeName": "my_volume"
    }
}