How to Remove Instances from a Cluster

Removing instances from a cluster detaches them from the cluster and removes their fabric networking associations. The instances are not destroyed, they remain on your account as standalone servers.

This guide explains how to remove instances from a cluster using the Vultr API.

1. Send a GET request to the List Clusters endpoint to retrieve all clusters.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the cluster from which you want to remove instances.

2. Send a GET request to the Get Cluster endpoint to retrieve the cluster details. Replace {cluster-id} with the cluster id.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the instance(s) you want to remove from the cluster.

Remove Multiple Instances

1. Send a POST request to the Mass Update Cluster Instances endpoint to remove multiple instances from the cluster. Replace {cluster-id} with the cluster id and provide the instance IDs in the instances array. Set action to remove.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}" \
       -X POST \
       -H "Authorization: Bearer ${VULTR_API_KEY}" \
       -H "Content-Type: application/json" \
       -d '{
           "action": "remove",
           "instances": [
               "INSTANCE-ID-1",
               "INSTANCE-ID-2"
           ]
       }'

   Explain Code

   Powered by Vultr AgentBeta

   A successful request returns an HTTP 202 Accepted response.

2. Send a GET request to the Get Cluster endpoint to retrieve the cluster details.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Verify that the removed instances no longer appear in the cluster's instance list.

Remove a Single Instance

1. Send a POST request to the Remove Single Instance endpoint to remove a single instance from the cluster. Replace {cluster-id} with the cluster id and {instance-id} with the instance id.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}/remove/{instance-id}" \
       -X POST \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   A successful request returns an HTTP 202 Accepted response.

2. Send a GET request to the Get Cluster endpoint to retrieve the cluster details.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Verify that the instance no longer appears in the cluster's instance list.