load-balancer

Create load balancer

Creates a new load balancer service.

post/1.3/load-balancer

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer
  • Auth: HTTP bearer

Request body

namestring required

Name of the service

zonestring required

Zone

planstring required

Plan

configured_status'started' | 'stopped' required

Service configured status

backendsLoadBalancerBackendCreate[] (unresolved $ref)

Service backends

network_uuidstring uuid

Private Network UUID

maintenance_dow'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday'

Day of week

maintenance_timestring

Maintenance time

Example request

{
  "name": "my-loadbalancer",
  "zone": "fi-hel1",
  "plan": "production-small",
  "configured_status": "started",
  "frontends": []
}

Response

Created

uuidstring uuid required

Unique identifier of the service.

namestring required

Human-readable name assigned to the service.

zonestring required

UpCloud zone where the service is deployed.

planstring required

Selected load balancer plan defining node size, performance, and pricing tier.

configured_statusstring required

Configuration status of the service (e.g., whether all components are correctly provisioned).

operational_state'pending' | 'running' | 'failing' | 'stopped' | 'degraded'

Current operational state of the service, describing its runtime behavior and availability.

maintenance_dow'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'

Day of week scheduled for maintenance operations.

maintenance_timestring time

Time of day (in UTC) scheduled for maintenance operations.

created_atstring date-time required

Timestamp when the service was created.

updated_atstring date-time required

Timestamp when the service was last updated.

network_uuidstring

Deprecated: old field replaced by the networks array.

dns_namestring

Deprecated: legacy DNS field replaced by service-level IP addressing.

Example response

{
  "uuid": "b7a3f6a4-4a8f-4a5c-b7a5-9c9a1e5a6d3e",
  "name": "loadbalancer-prod-eu",
  "zone": "de-fra1",
  "plan": "medium",
  "configured_status": "configured",
  "operational_state": "running",
  "frontends": [],
  "backends": [],
  "resolvers": [],
  "networks": [],
  "ip_addresses": [],
  "labels": [],
  "maintenance_dow": "tuesday",
  "maintenance_time": "02:00:00.000Z",
  "created_at": "2025-11-06T08:00:00.000Z",
  "updated_at": "2025-11-06T09:15:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.