Add

API Reference

GPU Droplets

Load Balancers

Droplets

Add Droplets to a Load Balancer

client.gpuDroplets.loadBalancers.droplets.add(stringlbID, DropletAddParams { droplet_ids } body, RequestOptionsoptions?): void

post/v2/load_balancers/{lb_id}/droplets

To assign a Droplet to a load balancer instance, send a POST 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. Individual Droplets can not be added to a load balancer configured with a Droplet tag. Attempting to do so will result in a "422 Unprocessable Entity" response from the API.

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: DropletAddParams { droplet_ids }

droplet_ids: Array<number>

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

Add Droplets to a Load Balancer

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

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

Returns Examples