Update
Update a Load Balancer
client.gpuDroplets.loadBalancers.update(stringlbID, LoadBalancerUpdateParamsbody, RequestOptionsoptions?): LoadBalancerUpdateResponse { load_balancer }
/v2/load_balancers/{lb_id}
To update a load balancer's settings, send a PUT request to
/v2/load_balancers/$LOAD_BALANCER_ID
. The request should contain a full
representation of the load balancer including existing attributes. It may
contain one of the droplets_ids
or tag
attributes as they are mutually
exclusive. Note that any attribute that is not provided will be reset to its
default value.
Parameters
lbID: string
Returns
Update a Load Balancer
import Gradient from '@digitalocean/gradient';
const client = new Gradient();
const loadBalancer = await client.gpuDroplets.loadBalancers.update('4de7ac8b-495b-4884-9a69-1050c6793cd6', {
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,
},
],
algorithm: 'round_robin',
droplet_ids: [3164444, 3164445],
enable_backend_keepalive: true,
enable_proxy_protocol: true,
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'] },
health_check: {
protocol: 'http',
port: 80,
path: '/',
check_interval_seconds: 10,
response_timeout_seconds: 5,
healthy_threshold: 5,
unhealthy_threshold: 3,
},
http_idle_timeout_seconds: 60,
name: 'updated-example-lb-01',
project_id: '9cc10173-e9ea-4176-9dbc-a4cee4c4ff30',
region: 'nyc3',
sticky_sessions: { type: 'none' },
vpc_uuid: 'c33931f2-a26a-4e61-b85c-4e95a2ec431b',
});
console.log(loadBalancer.load_balancer);
{
"load_balancer": {
"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"name": "updated-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": true,
"enable_backend_keepalive": true,
"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
{
"load_balancer": {
"id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"name": "updated-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": true,
"enable_backend_keepalive": true,
"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"
]
}
}
}