load-balancer

Modify load balancer network

Modifies existing service network by given {service-uuid} and {network-name}.

patch/1.3/load-balancer/{service-uuid}/networks/{network-name}

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/load-balancer/{service-uuid}/networks/{network-name}
  • Auth: HTTP bearer

Path parameters

service-uuidstring uuid required

The UUID of the service.

Example:01234567-89ab-cdef-0123-456789abcdef

The unique identifier for the service.

network-namestring required

The name of the network.

Example:example-network-1

The unique identifier for the network.

Request body

namestring

Name of the network

Example request

{
  "name": "updated-network"
}

Response

Created

namestring required

Human-readable name assigned to the network.

uuidstring required

UUID represented as a string

typestring required

Network type indicating the visibility scope (public or private).

familystring required

IP address family used by this network (IPv4 or IPv6).

dns_namestring

Fully qualified domain name (FQDN) for accessing the load balancer through this network.

created_atstring date-time required

Timestamp when the network was created (RFC 3339 format).

updated_atstring date-time required

Timestamp when the network was last updated (RFC 3339 format).

Example response

{
  "name": "public-network",
  "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "type": "private",
  "family": "IPv4",
  "dns_name": "lb-network.local",
  "created_at": "2025-11-06T09:00:00.000Z",
  "updated_at": "2025-11-06T11:15:00.000Z"
}

Changes

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