Create
Create a New 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_idsto a list of specific Droplet IDs. - Set
tagto 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.
Body Parameters
bodyunion
One of the following 2 object variants:
Returns
load_balancerforwarding_rulesarray of ForwardingRuleidstringalgorithmenumcreated_atstringdisable_lets_encrypt_dns_recordsbooleandomainsarray of Domainsdroplet_idsarray of numberenable_backend_keepalivebooleanenable_proxy_protocolbooleanfirewallLbFirewallglb_settingsGlbSettingshealth_checkHealthCheckhttp_idle_timeout_secondsnumberipstringipv6stringnamestringnetworkenumnetwork_stackenumproject_idstringredirect_http_to_httpsbooleanregionRegionsizeenumsize_unitnumberstatusenumsticky_sessionsStickySessionstagstringtarget_load_balancer_idsarray of stringtls_cipher_policyenumtypeenumvpc_uuidstringLoadBalancer
optional
curl https://api.digitalocean.com//v2/load_balancers \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $GRADIENTAI_API_KEY" \
-d '{
"forwarding_rules": [
{
"entry_port": 443,
"entry_protocol": "https",
"target_port": 80,
"target_protocol": "http"
}
],
"algorithm": "round_robin",
"disable_lets_encrypt_dns_records": true,
"droplet_ids": [
3164444,
3164445
],
"enable_backend_keepalive": true,
"enable_proxy_protocol": true,
"http_idle_timeout_seconds": 90,
"name": "example-lb-01",
"network": "EXTERNAL",
"network_stack": "IPV4",
"project_id": "4de7ac8b-495b-4884-9a69-1050c6793cd6",
"redirect_http_to_https": true,
"region": "nyc3",
"size": "lb-small",
"size_unit": 3,
"target_load_balancer_ids": [
"7dbf91fe-cbdb-48dc-8290-c3a181554905",
"996fa239-fac3-42a2-b9a1-9fa822268b7a"
],
"tls_cipher_policy": "STRONG",
"type": "REGIONAL",
"vpc_uuid": "c33931f2-a26a-4e61-b85c-4e95a2ec431b"
}'200 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"
]
}
}
}