Create

API Reference

GPU Droplets

Load Balancers

Create a New Load Balancer

client.gpuDroplets.loadBalancers.create(LoadBalancerCreateParamsbody, RequestOptionsoptions?): LoadBalancerCreateResponse { load_balancer }

post/v2/load_balancers

To create a new load balancer instance, send a POST request to /v2/load_balancers.

You can specify the Droplets that will sit behind the load balancer using one of two methods:

• Set droplet_ids to a list of specific Droplet IDs.
• Set tag to the name of a tag. All Droplets with this tag applied will be assigned to the load balancer. Additional Droplets will be automatically assigned as they are tagged.

These methods are mutually exclusive.

ParametersExpand Collapse

LoadBalancerCreateParams = AssignDropletsByID | AssignDropletsByTag

LoadBalancerCreateParamsBase { forwarding_rules, algorithm, disable_lets_encrypt_dns_records, 21 more }

forwarding_rules: Array<ForwardingRule { entry_port, entry_protocol, target_port, 3 more } >

An array of objects specifying the forwarding rules for a load balancer.

entry_port: number

An integer representing the port on which the load balancer instance will listen.

entry_protocol: "http" | "https" | "http2" | 3 more

The protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Accepts one of the following:

"http"

"https"

"http2"

"http3"

"tcp"

"udp"

target_port: number

An integer representing the port on the backend Droplets to which the load balancer will send traffic.

target_protocol: "http" | "https" | "http2" | 2 more

The protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Accepts one of the following:

"http"

"https"

"http2"

"tcp"

"udp"

certificate_id?: string

The ID of the TLS certificate used for SSL termination if enabled.

tls_passthrough?: boolean

A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

Deprecatedalgorithm?: "round_robin" | "least_connections"

This field has been deprecated. You can no longer specify an algorithm for load balancers.

Accepts one of the following:

"round_robin"

"least_connections"

disable_lets_encrypt_dns_records?: boolean

A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer.

domains?: Array<Domains { certificate_id, is_managed, name } >

An array of objects specifying the domain configurations for a Global load balancer.

certificate_id?: string

The ID of the TLS certificate used for SSL termination.

is_managed?: boolean

A boolean value indicating if the domain is already managed by DigitalOcean. If true, all A and AAAA records required to enable Global load balancers will be automatically added.

name?: string

FQDN to associate with a Global load balancer.

droplet_ids?: Array<number>

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

enable_backend_keepalive?: boolean

A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets.

enable_proxy_protocol?: boolean

A boolean value indicating whether PROXY Protocol is in use.

firewall?: LbFirewall { allow, deny }

An object specifying allow and deny rules to control traffic to the load balancer.

allow?: Array<string>

the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

deny?: Array<string>

the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

glb_settings?: GlbSettings { cdn, failover_threshold, region_priorities, 2 more }

An object specifying forwarding configurations for a Global load balancer.

cdn?: Cdn { is_enabled }

An object specifying CDN configurations for a Global load balancer.

is_enabled?: boolean

A boolean flag to enable CDN caching.

failover_threshold?: number

An integer value as a percentage to indicate failure threshold to decide how the regional priorities will take effect. A value of 50 would indicate that the Global load balancer will choose a lower priority region to forward traffic to once this failure threshold has been reached for the higher priority region.

region_priorities?: Record<string, number>

A map of region string to an integer priority value indicating preference for which regional target a Global load balancer will forward traffic to. A lower value indicates a higher priority.

target_port?: number

An integer representing the port on the target backends which the load balancer will forward traffic to.

target_protocol?: "http" | "https" | "http2"

The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.

Accepts one of the following:

"http"

"https"

"http2"

health_check?: HealthCheck { check_interval_seconds, healthy_threshold, path, 4 more }

An object specifying health check settings for the load balancer.

check_interval_seconds?: number

The number of seconds between between two consecutive health checks.

healthy_threshold?: number

The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

path?: string

The path on the backend Droplets to which the load balancer instance will send a request.

port?: number

An integer representing the port on the backend Droplets on which the health check will attempt a connection.

protocol?: "http" | "https" | "tcp"

The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.

Accepts one of the following:

"http"

"https"

"tcp"

response_timeout_seconds?: number

The number of seconds the load balancer instance will wait for a response until marking a health check as failed.

unhealthy_threshold?: number

The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.

http_idle_timeout_seconds?: number

An integer value which configures the idle timeout for HTTP requests to the target droplets.

minimum30

maximum600

name?: string

A human-readable name for a load balancer instance.

network?: "EXTERNAL" | "INTERNAL"

A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.

Accepts one of the following:

"EXTERNAL"

"INTERNAL"

network_stack?: "IPV4" | "DUALSTACK"

A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.

Accepts one of the following:

"IPV4"

"DUALSTACK"

project_id?: string

The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created.

redirect_http_to_https?: boolean

A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443.

region?: "ams1" | "ams2" | "ams3" | 12 more

The slug identifier for the region where the resource will initially be available.

Accepts one of the following:

"ams1"

"ams2"

"ams3"

"blr1"

"fra1"

"lon1"

"nyc1"

"nyc2"

"nyc3"

"sfo1"

"sfo2"

"sfo3"

"sgp1"

"tor1"

"syd1"

Deprecatedsize?: "lb-small" | "lb-medium" | "lb-large"

This field has been replaced by the size_unit field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.

• lb-small = 1 node
• lb-medium = 3 nodes
• lb-large = 6 nodes

You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation.

Accepts one of the following:

"lb-small"

"lb-medium"

"lb-large"

size_unit?: number

How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the size field to scale load balancers that reside in these regions.

minimum1

maximum100

sticky_sessions?: StickySessions { cookie_name, cookie_ttl_seconds, type }

An object specifying sticky sessions settings for the load balancer.

cookie_name?: string

The name of the cookie sent to the client. This attribute is only returned when using cookies for the sticky sessions type.

cookie_ttl_seconds?: number

The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using cookies for the sticky sessions type.

type?: "cookies" | "none"

An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.

Accepts one of the following:

"cookies"

"none"

target_load_balancer_ids?: Array<string>

An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer.

tls_cipher_policy?: "DEFAULT" | "STRONG"

A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are DEFAULT or STRONG. The default value is DEFAULT.

Accepts one of the following:

"DEFAULT"

"STRONG"

type?: "REGIONAL" | "REGIONAL_NETWORK" | "GLOBAL"

A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.

Accepts one of the following:

"REGIONAL"

"REGIONAL_NETWORK"

"GLOBAL"

vpc_uuid?: string

A string specifying the UUID of the VPC to which the load balancer is assigned.

formatuuid

AssignDropletsByID extends LoadBalancerCreateParamsBase { forwarding_rules, algorithm, disable_lets_encrypt_dns_records, 21 more }

AssignDropletsByTag extends LoadBalancerCreateParamsBase { forwarding_rules, algorithm, disable_lets_encrypt_dns_records, 21 more }

ReturnsExpand Collapse

LoadBalancerCreateResponse { load_balancer }

load_balancer?: LoadBalancer { forwarding_rules, id, algorithm, 27 more }

forwarding_rules: Array<ForwardingRule { entry_port, entry_protocol, target_port, 3 more } >

An array of objects specifying the forwarding rules for a load balancer.

entry_port: number

An integer representing the port on which the load balancer instance will listen.

entry_protocol: "http" | "https" | "http2" | 3 more

The protocol used for traffic to the load balancer. The possible values are: http, https, http2, http3, tcp, or udp. If you set the entry_protocol to udp, the target_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Accepts one of the following:

"http"

"https"

"http2"

"http3"

"tcp"

"udp"

target_port: number

An integer representing the port on the backend Droplets to which the load balancer will send traffic.

target_protocol: "http" | "https" | "http2" | 2 more

The protocol used for traffic from the load balancer to the backend Droplets. The possible values are: http, https, http2, tcp, or udp. If you set the target_protocol to udp, the entry_protocol must be set to udp. When using UDP, the load balancer requires that you set up a health check with a port that uses TCP, HTTP, or HTTPS to work properly.

Accepts one of the following:

"http"

"https"

"http2"

"tcp"

"udp"

certificate_id?: string

The ID of the TLS certificate used for SSL termination if enabled.

tls_passthrough?: boolean

A boolean value indicating whether SSL encrypted traffic will be passed through to the backend Droplets.

id?: string

A unique ID that can be used to identify and reference a load balancer.

formatuuid

Deprecatedalgorithm?: "round_robin" | "least_connections"

This field has been deprecated. You can no longer specify an algorithm for load balancers.

Accepts one of the following:

"round_robin"

"least_connections"

created_at?: string

A time value given in ISO8601 combined date and time format that represents when the load balancer was created.

formatdate-time

disable_lets_encrypt_dns_records?: boolean

A boolean value indicating whether to disable automatic DNS record creation for Let's Encrypt certificates that are added to the load balancer.

domains?: Array<Domains { certificate_id, is_managed, name } >

An array of objects specifying the domain configurations for a Global load balancer.

certificate_id?: string

The ID of the TLS certificate used for SSL termination.

is_managed?: boolean

A boolean value indicating if the domain is already managed by DigitalOcean. If true, all A and AAAA records required to enable Global load balancers will be automatically added.

name?: string

FQDN to associate with a Global load balancer.

droplet_ids?: Array<number>

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

enable_backend_keepalive?: boolean

A boolean value indicating whether HTTP keepalive connections are maintained to target Droplets.

enable_proxy_protocol?: boolean

A boolean value indicating whether PROXY Protocol is in use.

firewall?: LbFirewall { allow, deny }

An object specifying allow and deny rules to control traffic to the load balancer.

allow?: Array<string>

the rules for allowing traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

deny?: Array<string>

the rules for denying traffic to the load balancer (in the form 'ip:1.2.3.4' or 'cidr:1.2.0.0/16')

glb_settings?: GlbSettings { cdn, failover_threshold, region_priorities, 2 more }

An object specifying forwarding configurations for a Global load balancer.

cdn?: Cdn { is_enabled }

An object specifying CDN configurations for a Global load balancer.

is_enabled?: boolean

A boolean flag to enable CDN caching.

failover_threshold?: number

An integer value as a percentage to indicate failure threshold to decide how the regional priorities will take effect. A value of 50 would indicate that the Global load balancer will choose a lower priority region to forward traffic to once this failure threshold has been reached for the higher priority region.

region_priorities?: Record<string, number>

A map of region string to an integer priority value indicating preference for which regional target a Global load balancer will forward traffic to. A lower value indicates a higher priority.

target_port?: number

An integer representing the port on the target backends which the load balancer will forward traffic to.

target_protocol?: "http" | "https" | "http2"

The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are http, https and http2.

Accepts one of the following:

"http"

"https"

"http2"

health_check?: HealthCheck { check_interval_seconds, healthy_threshold, path, 4 more }

An object specifying health check settings for the load balancer.

check_interval_seconds?: number

The number of seconds between between two consecutive health checks.

healthy_threshold?: number

The number of times a health check must pass for a backend Droplet to be marked "healthy" and be re-added to the pool.

path?: string

The path on the backend Droplets to which the load balancer instance will send a request.

port?: number

An integer representing the port on the backend Droplets on which the health check will attempt a connection.

protocol?: "http" | "https" | "tcp"

The protocol used for health checks sent to the backend Droplets. The possible values are http, https, or tcp.

Accepts one of the following:

"http"

"https"

"tcp"

response_timeout_seconds?: number

The number of seconds the load balancer instance will wait for a response until marking a health check as failed.

unhealthy_threshold?: number

The number of times a health check must fail for a backend Droplet to be marked "unhealthy" and be removed from the pool.

http_idle_timeout_seconds?: number

An integer value which configures the idle timeout for HTTP requests to the target droplets.

minimum30

maximum600

ip?: string

An attribute containing the public-facing IP address of the load balancer.

ipv6?: string

An attribute containing the public-facing IPv6 address of the load balancer.

name?: string

A human-readable name for a load balancer instance.

network?: "EXTERNAL" | "INTERNAL"

A string indicating whether the load balancer should be external or internal. Internal load balancers have no public IPs and are only accessible to resources on the same VPC network. This property cannot be updated after creating the load balancer.

Accepts one of the following:

"EXTERNAL"

"INTERNAL"

network_stack?: "IPV4" | "DUALSTACK"

A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer.

Accepts one of the following:

"IPV4"

"DUALSTACK"

project_id?: string

The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created.

redirect_http_to_https?: boolean

A boolean value indicating whether HTTP requests to the load balancer on port 80 will be redirected to HTTPS on port 443.

region?: Region { available, features, name, 2 more }

The region where the load balancer instance is located. When setting a region, the value should be the slug identifier for the region. When you query a load balancer, an entire region object will be returned.

available: boolean

This is a boolean value that represents whether new Droplets can be created in this region.

features: Array<string>

This attribute is set to an array which contains features available in this region

name: string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

sizes: Array<string>

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

slug: string

A human-readable string that is used as a unique identifier for each region.

Deprecatedsize?: "lb-small" | "lb-medium" | "lb-large"

This field has been replaced by the size_unit field for all regions except in AMS2, NYC2, and SFO1. Each available load balancer size now equates to the load balancer having a set number of nodes.

• lb-small = 1 node
• lb-medium = 3 nodes
• lb-large = 6 nodes

You can resize load balancers after creation up to once per hour. You cannot resize a load balancer within the first hour of its creation.

Accepts one of the following:

"lb-small"

"lb-medium"

"lb-large"

size_unit?: number

How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the size field to scale load balancers that reside in these regions.

minimum1

maximum100

status?: "new" | "active" | "errored"

A status string indicating the current state of the load balancer. This can be new, active, or errored.

Accepts one of the following:

"new"

"active"

"errored"

sticky_sessions?: StickySessions { cookie_name, cookie_ttl_seconds, type }

An object specifying sticky sessions settings for the load balancer.

cookie_name?: string

The name of the cookie sent to the client. This attribute is only returned when using cookies for the sticky sessions type.

cookie_ttl_seconds?: number

The number of seconds until the cookie set by the load balancer expires. This attribute is only returned when using cookies for the sticky sessions type.

type?: "cookies" | "none"

An attribute indicating how and if requests from a client will be persistently served by the same backend Droplet. The possible values are cookies or none.

Accepts one of the following:

"cookies"

"none"

tag?: string

The name of a Droplet tag corresponding to Droplets assigned to the load balancer.

target_load_balancer_ids?: Array<string>

An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer.

tls_cipher_policy?: "DEFAULT" | "STRONG"

A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are DEFAULT or STRONG. The default value is DEFAULT.

Accepts one of the following:

"DEFAULT"

"STRONG"

type?: "REGIONAL" | "REGIONAL_NETWORK" | "GLOBAL"

A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer.

Accepts one of the following:

"REGIONAL"

"REGIONAL_NETWORK"

"GLOBAL"

vpc_uuid?: string

A string specifying the UUID of the VPC to which the load balancer is assigned.

formatuuid

Create a New Load Balancer

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const loadBalancer = await client.gpuDroplets.loadBalancers.create({
  forwarding_rules: [
    { entry_protocol: 'http', entry_port: 80, target_protocol: 'http', target_port: 80 },
    {
      entry_protocol: 'https',
      entry_port: 443,
      target_protocol: 'https',
      target_port: 443,
      tls_passthrough: true,
    },
  ],
  droplet_ids: [3164444, 3164445],
  firewall: { deny: ['cidr:1.2.0.0/16', 'ip:2.3.4.5'], allow: ['ip:1.2.3.4', 'cidr:2.3.4.0/24'] },
  http_idle_timeout_seconds: 60,
  name: 'example-lb-01',
  project_id: '9cc10173-e9ea-4176-9dbc-a4cee4c4ff30',
  region: 'nyc3',
});

console.log(loadBalancer.load_balancer);

202 example

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "104.131.186.241",
    "size": "lb-small",
    "algorithm": "round_robin",
    "status": "new",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 443,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "none"
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "tag": "",
    "droplet_ids": [
      3164444,
      3164445
    ],
    "redirect_http_to_https": false,
    "enable_proxy_protocol": false,
    "enable_backend_keepalive": false,
    "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b",
    "disable_lets_encrypt_dns_records": false,
    "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    "http_idle_timeout_seconds": 60,
    "firewall": {
      "deny": [
        "cidr:1.2.0.0/16",
        "ip:2.3.4.5"
      ],
      "allow": [
        "ip:1.2.3.4",
        "cidr:2.3.4.0/24"
      ]
    }
  }
}

Returns Examples

202 example

{
  "load_balancer": {
    "id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
    "name": "example-lb-01",
    "ip": "104.131.186.241",
    "size": "lb-small",
    "algorithm": "round_robin",
    "status": "new",
    "created_at": "2017-02-01T22:22:58Z",
    "forwarding_rules": [
      {
        "entry_protocol": "http",
        "entry_port": 80,
        "target_protocol": "http",
        "target_port": 80,
        "certificate_id": "",
        "tls_passthrough": false
      },
      {
        "entry_protocol": "https",
        "entry_port": 443,
        "target_protocol": "https",
        "target_port": 443,
        "certificate_id": "",
        "tls_passthrough": true
      }
    ],
    "health_check": {
      "protocol": "http",
      "port": 80,
      "path": "/",
      "check_interval_seconds": 10,
      "response_timeout_seconds": 5,
      "healthy_threshold": 5,
      "unhealthy_threshold": 3
    },
    "sticky_sessions": {
      "type": "none"
    },
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192gb"
      ],
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent"
      ],
      "available": true
    },
    "tag": "",
    "droplet_ids": [
      3164444,
      3164445
    ],
    "redirect_http_to_https": false,
    "enable_proxy_protocol": false,
    "enable_backend_keepalive": false,
    "vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b",
    "disable_lets_encrypt_dns_records": false,
    "project_id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30",
    "http_idle_timeout_seconds": 60,
    "firewall": {
      "deny": [
        "cidr:1.2.0.0/16",
        "ip:2.3.4.5"
      ],
      "allow": [
        "ip:1.2.3.4",
        "cidr:2.3.4.0/24"
      ]
    }
  }
}