Drop Cluster

Deletes a cluster. This operation moves your cluster to the recycle bin. All clusters in the recycle bin are pending permanent deletion in 30 days.

DELETE

/v1/clusters/{CLUSTER_ID}/drop

Base URL

The base URL for this API is in the following format:

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘Notes

• You need to replace ${CLOUD_REGION} with the appropriate region for your deployment.
• To get the cloud region ID, refer to On Zilliz Cloud Console or List Cloud Regions.

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}

CLUSTER_IDstringpathrequired

The ID of the cluster to drop.

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="undefined"

curl --request DELETE \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}/drop" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

A success response.

codeinteger

Response code.

dataobject

Response payload which is an object containing the ID of the cluster.

clusterIdstring

The ID of the cluster.

promptstring

The statement indicating that the current operation succeeds.

FAILURE

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 200,
    "data": {
        "clusterId": "inxx-xxxxxxxxxxxxxxx",
        "prompt": "The cluster has been deleted. If you consider this action to be an error, you have the option to restore the deleted cluster from the recycle bin within a 30-day period. Kindly note, this recovery feature does not apply to free clusters."
    }
}