# UpCloud Load Balancer API

**Canonical:** https://apis.io/apis/upcloud/upcloud-load-balancer-api/  
**Provider:** UpCloud — https://apis.io/providers/upcloud/  
**Base URL:** https://api.upcloud.com  
**Documentation:** https://developers.upcloud.com/api/1.3

UpCloud Load Balancer API is one of 29 APIs that [UpCloud](https://apis.io/providers/upcloud/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Load Balancer. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

A Managed load balancer works as the network level frontend of customer application by directing connections to the backend servers. The Managed load balancer API allows customer to manage their services. Managed load balancers are available in every UpCloud zone. The API requests and responses payload are in JSON format only. API follows JSON Merge Patch semantics. Note when modifying nested structures payload should contain entire array, which in a sense is PUT within PATCH for them. JSON Merge Patch uses null to explicitly indicate property deletion while absent properties are ignored, i.e. not modified. It is recommended to use the hostnames of your load balancer when directing your domain to it. This ensures utilization of all addresses that the load balancer might possess. For the subdomains of your domain, use CNAME. For the primary domain, you might need to use ALIAS, or whatever is supported by your DNS provider.

## Operations (60 of 73)

| Method | Path | Summary |
|---|---|---|
| GET | `/1.3/load-balancer` | List load balancers |
| POST | `/1.3/load-balancer` | Create load balancer |
| GET | `/1.3/load-balancer/{service-uuid}` | Get load balancer |
| PUT | `/1.3/load-balancer/{service-uuid}` | Replace load balancer |
| DELETE | `/1.3/load-balancer/{service-uuid}` | Delete load balancer |
| PATCH | `/1.3/load-balancer/{service-uuid}` | Modify load balancer |
| GET | `/1.3/load-balancer/{service-uuid}/frontends` | List load balancer frontends |
| POST | `/1.3/load-balancer/{service-uuid}/frontends` | Create load balancer frontend |
| GET | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}` | Get load balancer frontend |
| DELETE | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}` | Delete load balancer frontend |
| PATCH | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}` | Modify load balancer frontend |
| GET | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs` | List load balancer frontend TLS configs |
| POST | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs` | Create load balancer frontend TLS config |
| GET | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}` | Get load balancer frontend TLS config |
| DELETE | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}` | Delete load balancer frontend TLS config |
| PATCH | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}` | Modify load balancer frontend TLS config |
| GET | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules` | List load balancer rules |
| POST | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules` | Create load balancer rule |
| GET | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}` | Get load balancer rule |
| PUT | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}` | Replace load balancer rule |
| DELETE | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}` | Delete load balancer rule |
| PATCH | `/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}` | Modify load balancer rule |
| GET | `/1.3/load-balancer/{service-uuid}/backends` | List load balancer backends |
| POST | `/1.3/load-balancer/{service-uuid}/backends` | Create load balancer backend |
| GET | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}` | Get load balancer backend |
| DELETE | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}` | Delete load balancer backend |
| PATCH | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}` | Modify load balancer backend |
| GET | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members` | List load balancer members |
| POST | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members` | Create load balancer member |
| GET | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}` | Get load balancer member |
| DELETE | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}` | Delete load balancer member |
| PATCH | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}` | Modify load balancer member |
| GET | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs` | List load balancer backend TLS configs |
| POST | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs` | Create load balancer backend TLS config |
| GET | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}` | Get load balancer backend TLS config |
| DELETE | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}` | Delete load balancer backend TLS config |
| PATCH | `/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}` | Modify load balancer backend TLS config |
| PATCH | `/1.3/load-balancer/{service-uuid}/networks/{network-name}` | Modify load balancer network |
| GET | `/1.3/load-balancer/{service-uuid}/ip-addresses` | List load balancer IP addresses |
| POST | `/1.3/load-balancer/{service-uuid}/ip-addresses` | Create load balancer IP address |
| GET | `/1.3/load-balancer/{service-uuid}/ip-addresses/{ip-address}` | Get load balancer IP address |
| DELETE | `/1.3/load-balancer/{service-uuid}/ip-addresses/{ip-address}` | Delete load balancer IP address |
| GET | `/1.3/load-balancer/{service-uuid}/resolvers` | List load balancer resolvers |
| POST | `/1.3/load-balancer/{service-uuid}/resolvers` | Create load balancer resolver |
| GET | `/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}` | Get load balancer resolver |
| DELETE | `/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}` | Delete load balancer resolver |
| PATCH | `/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}` | Modify load balancer resolver |
| GET | `/1.3/load-balancer/{service-uuid}/labels` | List load balancer labels |
| POST | `/1.3/load-balancer/{service-uuid}/labels` | Create load balancer label |
| GET | `/1.3/load-balancer/{service-uuid}/labels/{label-key}` | Get load balancer label |
| DELETE | `/1.3/load-balancer/{service-uuid}/labels/{label-key}` | Delete load balancer label |
| PATCH | `/1.3/load-balancer/{service-uuid}/labels/{label-key}` | Modify load balancer label |
| GET | `/1.3/load-balancer/{service-uuid}/metrics` | Get load balancer metrics |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series` | Get load balancer metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/frontends` | Get load balancer frontend combined metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/frontends/{frontend-name}` | Get load balancer frontend metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/backends` | Get load balancer backend combined metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}` | Get load balancer backend metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members` | Get load balancer member combined metrics series |
| GET | `/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members/{member-name}` | Get load balancer member metrics series |

…and 13 more operations. They are listed in full on the page.

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/upcloud/openapi/upcloud-load-balancer-api-openapi.yml
- **Documentation** — https://developers.upcloud.com/api/1.3

## Other UpCloud APIs (12)

- [UpCloud Account API](https://apis.io/apis/upcloud/upcloud-account-api/)
- [UpCloud Account Tokens API](https://apis.io/apis/upcloud/upcloud-account-tokens-api/)
- [UpCloud Audit Logs API](https://apis.io/apis/upcloud/upcloud-audit-logs-api/)
- [UpCloud Currency API](https://apis.io/apis/upcloud/upcloud-currency-api/)
- [UpCloud Database API](https://apis.io/apis/upcloud/upcloud-database-api/)
- [UpCloud Device API](https://apis.io/apis/upcloud/upcloud-device-api/)
- [UpCloud Events API](https://apis.io/apis/upcloud/upcloud-events-api/)
- [UpCloud File Storage API](https://apis.io/apis/upcloud/upcloud-file-storage-api/)
- [UpCloud Firewall Ruleset API](https://apis.io/apis/upcloud/upcloud-firewall-ruleset-api/)
- [UpCloud Gateway API](https://apis.io/apis/upcloud/upcloud-gateway-api/)
- [UpCloud Ip Address API](https://apis.io/apis/upcloud/upcloud-ip-address-api/)
- [UpCloud Kubernetes API](https://apis.io/apis/upcloud/upcloud-kubernetes-api/)

## Tags

Load Balancer

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/upcloud/upcloud-load-balancer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/upcloud/.