Skip to content
  • Auto
  • Light
  • Dark

Remove

Remove Droplets from a Load Balancer
client.gpuDroplets.loadBalancers.droplets.remove(stringlbID, DropletRemoveParams { droplet_ids } body, RequestOptionsoptions?): void
delete/v2/load_balancers/{lb_id}/droplets

To remove a Droplet from a load balancer instance, send a DELETE request to /v2/load_balancers/$LOAD_BALANCER_ID/droplets. In the body of the request, there should be a droplet_ids attribute containing a list of Droplet IDs.

No response body will be sent back, but the response code will indicate success. Specifically, the response code will be a 204, which means that the action was successful with no returned body data.

ParametersExpand Collapse
lbID: string
body: DropletRemoveParams { droplet_ids }
droplet_ids: Array<number>

An array containing the IDs of the Droplets assigned to the load balancer.

Remove Droplets from a Load Balancer
import Gradient from '@digitalocean/gradient';

const client = new Gradient();

await client.gpuDroplets.loadBalancers.droplets.remove('4de7ac8b-495b-4884-9a69-1050c6793cd6', {
  droplet_ids: [3164444, 3164445],
});
Returns Examples