Create a Load Balancer
POST
/load_balancers
Call specific error codes
| Code | Description |
|---|---|
cloud_resource_ip_not_allowed | The IP you are trying to add as a target belongs to a Hetzner Cloud resource |
ip_not_owned | The IP is not owned by the owner of the project of the Load Balancer |
load_balancer_not_attached_to_network | The Load Balancer is not attached to a network |
robot_unavailable | Robot was not available. The caller may retry the operation after a short delay. |
server_not_attached_to_network | The server you are trying to add as a target is not attached to the same network as the Load Balancer |
source_port_already_used | The source port you are trying to add is already in use |
target_already_defined | The Load Balancer target you are trying to define is already defined |
Request
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.hetzner.cloud/v1/load_balancers' \
--header 'Content-Type: application/json' \
--data-raw '{
"algorithm": {
"type": "round_robin"
},
"labels": {
"labelkey": "value"
},
"load_balancer_type": "lb11",
"location": "string",
"name": "Web Frontend",
"network": 123,
"network_zone": "eu-central",
"public_interface": true,
"services": [
{
"destination_port": 80,
"health_check": {
"http": {
"domain": "example.com",
"path": "/",
"response": "{\"status\": \"ok\"}",
"status_codes": [
"2??",
"3??"
],
"tls": false
},
"interval": 15,
"port": 4711,
"protocol": "http",
"retries": 3,
"timeout": 10
},
"http": {
"certificates": [
897
],
"cookie_lifetime": 300,
"cookie_name": "HCLBSTICKY",
"redirect_http": true,
"sticky_sessions": true
},
"listen_port": 443,
"protocol": "https",
"proxyprotocol": false
}
],
"targets": [
{
"health_status": [
{
"listen_port": 443,
"status": "healthy"
}
],
"ip": {
"ip": "203.0.113.1"
},
"label_selector": {
"selector": "env=prod"
},
"server": {
"id": 80
},
"targets": [
{
"health_status": [
{
"listen_port": 443,
"status": "healthy"
}
],
"server": {
"id": 85
},
"type": "server",
"use_private_ip": false
}
],
"type": "server",
"use_private_ip": true
}
]
}'Response Response Example
{
"action": {
"command": "create_load_balancer",
"error": {
"code": "action_failed",
"message": "Action failed"
},
"finished": "2016-01-30T23:56:00.000Z",
"id": 13,
"progress": 100,
"resources": [
{
"id": 4711,
"type": "load_balancer"
}
],
"started": "2016-01-30T23:55:00.000Z",
"status": "success"
},
"load_balancer": {
"algorithm": {
"type": "round_robin"
},
"created": "2016-01-30T23:50:00.000Z",
"id": 4711,
"included_traffic": 654321,
"ingoing_traffic": 123456,
"labels": {
"env": "dev"
},
"load_balancer_type": {
"deprecated": "2016-01-30T23:50:00.000Z",
"description": "LB11",
"id": 1,
"max_assigned_certificates": 10,
"max_connections": 20000,
"max_services": 5,
"max_targets": 25,
"name": "lb11",
"prices": [
{
"location": "fsn1",
"price_hourly": {
"gross": "1.1900000000000000",
"net": "1.0000000000"
},
"price_monthly": {
"gross": "1.1900000000000000",
"net": "1.0000000000"
}
}
]
},
"location": {
"city": "Falkenstein",
"country": "DE",
"description": "Falkenstein DC Park 1",
"id": 1,
"latitude": 50.47612,
"longitude": 12.370071,
"name": "fsn1",
"network_zone": "eu-central"
},
"name": "Web Frontend",
"outgoing_traffic": 123456,
"private_net": [
{
"ip": "10.0.0.2",
"network": 4711
}
],
"protection": {
"delete": false
},
"public_net": {
"enabled": false,
"ipv4": {
"ip": "1.2.3.4"
},
"ipv6": {
"ip": "2001:db8::1"
}
},
"services": [
{
"destination_port": 80,
"health_check": {
"http": {
"domain": "example.com",
"path": "/",
"response": "{\"status\": \"ok\"}",
"status_codes": [
"2??,3??"
],
"tls": false
},
"interval": 15,
"port": 4711,
"protocol": "http",
"retries": 3,
"timeout": 10
},
"http": {
"certificates": [
897
],
"cookie_lifetime": 300,
"cookie_name": "HCLBSTICKY",
"redirect_http": true,
"sticky_sessions": true
},
"listen_port": 443,
"protocol": "http",
"proxyprotocol": false
}
],
"targets": [
{
"health_status": [
{
"listen_port": 443,
"status": "healthy"
}
],
"server": {
"id": 80
},
"targets": [
{
"health_status": [
{
"listen_port": 443,
"status": "healthy"
}
],
"label_selector": null,
"server": {
"id": 80
},
"type": "server",
"use_private_ip": true
}
],
"type": "server",
"use_private_ip": true
}
]
}
}Modified at 2023-08-16 03:09:21