Skip to content
  • Auto
  • Light
  • Dark

List

List All Load Balancers
gpu_droplets.load_balancers.list(LoadBalancerListParams**kwargs) -> metaMetaPropertieslinksPageLinksload_balancerslistLoadBalancerListResponse
get/v2/load_balancers

To list all of the load balancer instances on your account, send a GET request to /v2/load_balancers.

Parameters
pageint
optional

Which 'page' of paginated results to return.

minimum1
per_pageint
optional

Number of items returned per page

minimum1
maximum200
Returns
LoadBalancerListResponseclass
Hide ParametersShow Parameters
metatotalintMetaProperties

Information about the response itself.

load_balancerslist
optional
Optional[List[forwarding_ruleslistidstralgorithmliteralcreated_atdatetimedisable_lets_encrypt_dns_recordsbooldomainslistdroplet_idslistenable_backend_keepaliveboolenable_proxy_protocolboolfirewallLbFirewallglb_settingsGlbSettingshealth_checkHealthCheckhttp_idle_timeout_secondsintipstripv6strnamestrnetworkliteralnetwork_stackliteralproject_idstrredirect_http_to_httpsboolregionRegionsizeliteralsize_unitintstatusliteralsticky_sessionsStickySessionstagstrtarget_load_balancer_idslisttls_cipher_policyliteraltypeliteralvpc_uuidstrLoadBalancer]]
Hide ParametersShow Parameters
forwarding_ruleslist
List[entry_portintentry_protocolliteraltarget_portinttarget_protocolliteralcertificate_idstrtls_passthroughboolForwardingRule]

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

Hide ParametersShow Parameters
entry_portint

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

entry_protocolliteral
Literal["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.

Hide ParametersShow Parameters
"http"
"https"
"http2"
"http3"
"tcp"
"udp"
target_portint

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

target_protocolliteral
Literal["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.

Hide ParametersShow Parameters
"http"
"https"
"http2"
"tcp"
"udp"
certificate_idstr
optional

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

tls_passthroughbool
optional

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

idstr
optional

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

formatuuid
algorithmliteral
optional
deprecated
Optional[Literal["round_robin", "least_connections"]]

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

Hide ParametersShow Parameters
"round_robin"
"least_connections"
created_atdatetime
optional

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_recordsbool
optional

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

domainslist
optional
Optional[List[certificate_idstris_managedboolnamestrDomains]]

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

Hide ParametersShow Parameters
certificate_idstr
optional

The ID of the TLS certificate used for SSL termination.

is_managedbool
optional

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.

namestr
optional

FQDN to associate with a Global load balancer.

droplet_idslist
optional
Optional[List[int]]

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

enable_backend_keepalivebool
optional

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

enable_proxy_protocolbool
optional

A boolean value indicating whether PROXY Protocol is in use.

firewallLbFirewall
optional

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

glb_settingsGlbSettings
optional

An object specifying forwarding configurations for a Global load balancer.

health_checkHealthCheck
optional

An object specifying health check settings for the load balancer.

http_idle_timeout_secondsint
optional

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

minimum30
maximum600
ipstr
optional

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

ipv6str
optional

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

namestr
optional

A human-readable name for a load balancer instance.

networkliteral
optional
Optional[Literal["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.

Hide ParametersShow Parameters
"EXTERNAL"
"INTERNAL"
network_stackliteral
optional
Optional[Literal["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.

Hide ParametersShow Parameters
"IPV4"
"DUALSTACK"
project_idstr
optional

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_httpsbool
optional

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

regionRegion
optional

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.

sizeliteral
optional
deprecated
Optional[Literal["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.

Hide ParametersShow Parameters
"lb-small"
"lb-medium"
"lb-large"
size_unitint
optional

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
statusliteral
optional
Optional[Literal["new", "active", "errored"]]

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

Hide ParametersShow Parameters
"new"
"active"
"errored"
sticky_sessionsStickySessions
optional

An object specifying sticky sessions settings for the load balancer.

tagstr
optional

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

target_load_balancer_idslist
optional
Optional[List[str]]

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

tls_cipher_policyliteral
optional
Optional[Literal["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.

Hide ParametersShow Parameters
"DEFAULT"
"STRONG"
typeliteral
optional
Optional[Literal["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.

Hide ParametersShow Parameters
"REGIONAL"
"REGIONAL_NETWORK"
"GLOBAL"
vpc_uuidstr
optional

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

formatuuid
from do_gradientai import GradientAI

client = GradientAI()
load_balancers = client.gpu_droplets.load_balancers.list()
print(load_balancers.meta)
200 Example
{
  "load_balancers": [
    {
      "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,
      "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"
        ]
      }
    },
    {
      "id": "56775c3f-04ab-4fb3-a7ed-40ef9bc8eece",
      "name": "prod-web-lb-01",
      "ip": "45.55.125.24",
      "size": "lb-small",
      "algorithm": "round_robin",
      "status": "active",
      "created_at": "2020-09-08T18:58:04Z",
      "forwarding_rules": [
        {
          "entry_protocol": "https",
          "entry_port": 443,
          "target_protocol": "http",
          "target_port": 8080,
          "certificate_id": "892071a0-bb95-49bc-8021-3afd67a210bf",
          "tls_passthrough": false
        }
      ],
      "health_check": {
        "protocol": "https",
        "port": 443,
        "path": "/",
        "check_interval_seconds": 10,
        "response_timeout_seconds": 5,
        "healthy_threshold": 5,
        "unhealthy_threshold": 3
      },
      "sticky_sessions": {
        "type": "cookies",
        "cookie_name": "DO-LB",
        "cookie_ttl_seconds": 300
      },
      "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": "prod:web",
      "droplet_ids": [
        55806512,
        55806515,
        55806524
      ],
      "redirect_http_to_https": true,
      "enable_proxy_protocol": false,
      "enable_backend_keepalive": false,
      "vpc_uuid": "587d698c-de84-11e8-80bc-3cfdfea9fcd1",
      "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"
        ]
      }
    }
  ],
  "links": {},
  "meta": {
    "total": 2
  }
}