For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.v2.load_balancers.byLb_id(lb_id).droplets.post(body: Load_balancer_droplet_ids, requestConfiguration?: RequestConfiguration<object>): Promise<void>

Description

To assign a Droplet to a load balancer instance, send a POST request to /v2/load_balancers/{lb_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.

Parameters

Path Parameters

lb_id string required

Example: 4de7ac8b-495b-4884-9a69-1050c6793cd6

A unique identifier for a load balancer.

Min: 1

Request Body

dropletIds array of integers required

Example: [3164444, 3164445]

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

Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

await client.v2.load_balancers
    .byLb_id("4de7ac8b-495b-4884-9a69-1050c6793cd6").droplets.post({
    dropletIds: [
        3164444,
        3164445,
    ],
});

More Information

See /v2/load_balancers/{lb_id}/droplets in the API reference for additional detail on responses, headers, parameters, and more.