How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpCloud Load Balancer API

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.

UpCloud Load Balancer API is one of 29 APIs that UpCloud publishes on the 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.

This API exposes 73 operations across 36 paths, and defines 142 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

73 operations 36 paths 142 schemas 12 DELETE35 GET12 PATCH12 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud Load Balancer API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 73

Across 36 paths, the API surfaces 73 operations — 12 DELETE, 35 GET, 12 PATCH, 12 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

load-balancer 73

A Managed load balancer works as the network level frontend of customer application by directing connections to the backend servers.

GET
/1.3/load-balancer
List load balancers
listLoadBalancers 4 params → 200default
POST
/1.3/load-balancer
Create load balancer
createLoadBalancer body → 201default
GET
/1.3/load-balancer/{service-uuid}
Get load balancer
getLoadBalancer 1 param → 200default
PUT
/1.3/load-balancer/{service-uuid}
Replace load balancer
replaceLoadBalancer 1 param body → 200default
DELETE
/1.3/load-balancer/{service-uuid}
Delete load balancer
deleteLoadBalancer 1 param → 204default
PATCH
/1.3/load-balancer/{service-uuid}
Modify load balancer
modifyLoadBalancer 1 param body → 200default
GET
/1.3/load-balancer/{service-uuid}/frontends
List load balancer frontends
listLoadBalancerFrontends 1 param → 200default
POST
/1.3/load-balancer/{service-uuid}/frontends
Create load balancer frontend
createLoadBalancerFrontend 1 param body → 201default
GET
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}
Get load balancer frontend
getLoadBalancerFrontend 2 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}
Delete load balancer frontend
deleteLoadBalancerFrontend 2 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}
Modify load balancer frontend
modifyLoadBalancerFrontend 2 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs
List load balancer frontend TLS configs
listLoadBalancerFrontendTlsConfigs 2 params → 200default
POST
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs
Create load balancer frontend TLS config
createLoadBalancerFrontendTlsConfig 2 params body → 201default
GET
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}
Get load balancer frontend TLS config
getLoadBalancerFrontendTlsConfig 3 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}
Delete load balancer frontend TLS config
deleteLoadBalancerFrontendTlsConfig 3 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/tls-configs/{tls-config-name}
Modify load balancer frontend TLS config
modifyLoadBalancerFrontendTlsConfig 3 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules
List load balancer rules
listLoadBalancerRules 2 params → 200default
POST
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules
Create load balancer rule
createLoadBalancerRule 2 params body → 201default
GET
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}
Get load balancer rule
getLoadBalancerRule 3 params → 200default
PUT
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}
Replace load balancer rule
replaceLoadBalancerRule 3 params body → 200default
DELETE
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}
Delete load balancer rule
deleteLoadBalancerRule 3 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/frontends/{frontend-name}/rules/{rule-name}
Modify load balancer rule
modifyLoadBalancerRule 3 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/backends
List load balancer backends
listLoadBalancerBackends 1 param → 200default
POST
/1.3/load-balancer/{service-uuid}/backends
Create load balancer backend
createLoadBalancerBackend 1 param body → 201default
GET
/1.3/load-balancer/{service-uuid}/backends/{backend-name}
Get load balancer backend
getLoadBalancerBackend 2 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/backends/{backend-name}
Delete load balancer backend
deleteLoadBalancerBackend 2 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/backends/{backend-name}
Modify load balancer backend
modifyLoadBalancerBackend 2 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members
List load balancer members
listLoadBalancerMembers 2 params → 200default
POST
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members
Create load balancer member
createLoadBalancerMember 2 params body → 201default
GET
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}
Get load balancer member
getLoadBalancerMember 3 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}
Delete load balancer member
deleteLoadBalancerMember 3 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/members/{member-name}
Modify load balancer member
modifyLoadBalancerMember 3 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs
List load balancer backend TLS configs
listLoadBalancerBackendTlsConfigs 2 params → 200default
POST
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs
Create load balancer backend TLS config
createLoadBalancerBackendTlsConfig 2 params body → 201default
GET
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}
Get load balancer backend TLS config
getLoadBalancerBackendTlsConfig 3 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}
Delete load balancer backend TLS config
deleteLoadBalancerBackendTlsConfig 3 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/backends/{backend-name}/tls-configs/{tls-config-name}
Modify load balancer backend TLS config
modifyLoadBalancerBackendTlsConfig 3 params body → 200default
PATCH
/1.3/load-balancer/{service-uuid}/networks/{network-name}
Modify load balancer network
modifyLoadBalancerNetwork 2 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/ip-addresses
List load balancer IP addresses
listLoadBalancerIpAddresses 1 param → 200default
POST
/1.3/load-balancer/{service-uuid}/ip-addresses
Create load balancer IP address
createLoadBalancerIpAddress 1 param body → 201default
GET
/1.3/load-balancer/{service-uuid}/ip-addresses/{ip-address}
Get load balancer IP address
getLoadBalancerIpAddress 2 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/ip-addresses/{ip-address}
Delete load balancer IP address
deleteLoadBalancerIpAddress 2 params → 204default
GET
/1.3/load-balancer/{service-uuid}/resolvers
List load balancer resolvers
listLoadBalancerResolvers 1 param → 200default
POST
/1.3/load-balancer/{service-uuid}/resolvers
Create load balancer resolver
createLoadBalancerResolver 1 param body → 201default
GET
/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}
Get load balancer resolver
getLoadBalancerResolver 2 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}
Delete load balancer resolver
deleteLoadBalancerResolver 2 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/resolvers/{resolver-name}
Modify load balancer resolver
modifyLoadBalancerResolver 2 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/labels
List load balancer labels
listLoadBalancerLabels 1 param → 200default
POST
/1.3/load-balancer/{service-uuid}/labels
Create load balancer label
createLoadBalancerLabel 1 param body → 201default
GET
/1.3/load-balancer/{service-uuid}/labels/{label-key}
Get load balancer label
getLoadBalancerLabel 2 params → 200default
DELETE
/1.3/load-balancer/{service-uuid}/labels/{label-key}
Delete load balancer label
deleteLoadBalancerLabel 2 params → 204default
PATCH
/1.3/load-balancer/{service-uuid}/labels/{label-key}
Modify load balancer label
modifyLoadBalancerLabel 2 params body → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics
Get load balancer metrics
getLoadBalancerMetrics 1 param → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series
Get load balancer metrics series
getLoadBalancerMetricsSeries 1 param → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/frontends
Get load balancer frontend combined metrics series
getLoadBalancerFrontendCombinedMetricsSeries 2 params → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/frontends/{frontend-name}
Get load balancer frontend metrics series
getLoadBalancerFrontendMetricsSeries 3 params → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/backends
Get load balancer backend combined metrics series
getLoadBalancerBackendCombinedMetricsSeries 2 params → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}
Get load balancer backend metrics series
getLoadBalancerBackendMetricsSeries 3 params → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members
Get load balancer member combined metrics series
getLoadBalancerMemberCombinedMetricsSeries 3 params → 200default
GET
/1.3/load-balancer/{service-uuid}/metrics/series/backends/{backend-name}/members/{member-name}
Get load balancer member metrics series
getLoadBalancerMemberMetricsSeries 4 params → 200default
GET
/1.3/load-balancer/certificate-bundles
List load balancer certificate bundles
listLoadBalancerCertificateBundles 3 params → 200default
POST
/1.3/load-balancer/certificate-bundles
Create load balancer certificate bundle
createLoadBalancerCertificateBundle body → 201default
GET
/1.3/load-balancer/certificate-bundles/{bundle-uuid}
Get load balancer certificate bundle
getLoadBalancerCertificateBundle 1 param → 200default
DELETE
/1.3/load-balancer/certificate-bundles/{bundle-uuid}
Delete load balancer certificate bundle
deleteLoadBalancerCertificateBundle 1 param → 204default
PATCH
/1.3/load-balancer/certificate-bundles/{bundle-uuid}
Modify load balancer certificate bundle
modifyLoadBalancerCertificateBundle 1 param body → 200default
GET
/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels
List load balancer certificate bundle labels
listLoadBalancerCertificateBundleLabels 1 param → 200default
POST
/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels
Create load balancer certificate bundle label
createLoadBalancerCertificateBundleLabel 1 param body → 201default
GET
/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels/{label-key}
Get load balancer certificate bundle label
getLoadBalancerCertificateBundleLabel 2 params → 200default
DELETE
/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels/{label-key}
Delete load balancer certificate bundle label
deleteLoadBalancerCertificateBundleLabel 2 params → 204default
PATCH
/1.3/load-balancer/certificate-bundles/{bundle-uuid}/labels/{label-key}
Modify load balancer certificate bundle label
modifyLoadBalancerCertificateBundleLabel 2 params body → 200default
GET
/1.3/load-balancer/certificate-bundles/dns-challenge-domain
Get load balancer DNS challenge domain
getLoadBalancerDnsChallengeDomain → 200default
GET
/1.3/load-balancer/plans
List load balancer plans
listLoadBalancerPlans 2 params → 200default
GET
/1.3/load-balancer/plans/{plan-name}
Get load balancer plan
getLoadBalancerPlan 1 param → 200default

Schemas 142

The contract defines 142 schemas that model the data the API accepts and returns. The most detailed are loadBalancerMemberMetricsSeriesResponse (23 properties), loadBalancerBackendMetricsSeries (22 properties), loadBalancerFrontendMetricsSeries (19 properties), loadBalancerBackendPropertiesResponse (18 properties). Each schema is shown below with its type and property counts.

loadBalancerActionResponse
object
Represents a rule action that defines how matched traffic should be processed or modified within the load balancer. Each action type includes a corresponding c…
10 properties 1 required
loadBalancerChallengeProblemResponse
object
Represents a problem encountered during ACME challenge validation for a specific hostname. Includes detailed error information following the Problem Details (R…
2 properties 2 required
loadBalancerMatcherStringCreate
Forwarding rule string matcher
loadBalancerServicesResponse
array
Response schema for a list of services.
loadBalancerCertificateBundleLabelsResponse
array
Represents a list of label key-value pairs attached to a certificate bundle within the load-balancer service, used for resource classification, billing and fil…
loadBalancerMaintenanceTime
string
Maintenance time
loadBalancerMatchStringWithArgResponse
Extends MatchString with an additional 'name' parameter, used for matchers that require a key-value pair (e.g., matching headers, cookies, or URL parameters).
loadBalancerServerMetricsResponse
object
Represents detailed server-level performance and reliability metrics, including connection errors, aborted sessions, and routing statistics for a load balancer…
9 properties 9 required
loadBalancerActionUseBackendCreate
object
Forwarding rule use backend action
1 property 1 required
loadBalancerLabelCreate
object
Load Balancer Label
2 properties 2 required
loadBalancerNetwork
object
Represent a network from where traffic is consumed and routed.
7 properties 6 required
loadBalancerNetworkType
string
Network type
loadBalancerIpAddressParameter
string
The IP address parameter.
loadBalancerResolverParameter
string
The name of the resolver.
loadBalancerIpAddressesResponse
array
A list of floating public IPv4 addresses attached to the load balancer service, each including its network interface metadata.
loadBalancerActionHttpRewriteUriResponse
object
Defines an action that rewrites the HTTP request URI using a regex pattern.
2 properties 2 required
loadBalancerFrontendModify
object
Load Balancer Frontend
8 properties
loadBalancerLabelModify
object
Load Balancer Label
2 properties
loadBalancerActionHttpRewriteUriCreate
object
Rewrite HTTP request URI using regex pattern
2 properties 2 required
loadBalancerRuleCreate
object
Load Balancer Forwarding Rule
5 properties 4 required
loadBalancerMatchIntResponse
object
Defines integer matching criteria for requests or responses.
4 properties 2 required
loadBalancerMatcherBackendCreate
object
Forwarding rule backend matcher
5 properties
loadBalancerRuleMatcherIntMethod
string
Method
loadBalancerBackendParameter
string
The name of the backend.
loadBalancerActionHttpRedirectResponse
object
Defines an HTTP redirection action used to redirect incoming requests to a specified URL with a given HTTP status code. Used when the action type is 'httpredir…
2 properties 2 required
loadBalancerIpAddress
object
Represents an IP address associated with a network interface of the load balancer service, including addressing details and provisioning information.
4 properties 4 required
loadBalancerResolversResponse
array
Represents a list of DNS resolver configurations for a load balancer service.
loadBalancerMemberType
string
Member type
loadBalancerMatchIpResponse
object
Defines a match condition based on the source IP address or subnet. Used when the matcher type is 'srcip'.
1 property 1 required
loadBalancerBackendPropertiesResponse
object
Properties of a backend configuration.
18 properties 15 required
loadBalancerMembersResponse
array
Response schema for a list of members.
loadBalancerEmbeddedServiceResponse
object
Represents a minimal embedded reference to a load balancer service, including its UUID, name, and lists of associated frontends and backends.
5 properties 2 required
loadBalancerCertificateBundleModify
Modify a load balancer certificate bundle (manual, dynamic, or authority type)
loadBalancerSortServicesParameter
string
Sort services by field. Prefix with '-' for descending order.
loadBalancerChecksOnDown
string
Checks on down category
loadBalancerFrontend
object
Represents a frontend configuration in the load balancer service, defining how client connections are received, the listening port and protocol, TLS settings,…
10 properties 10 required
loadBalancerCertificateBundleCreate
object
Load Balancer certificate bundle
9 properties 2 required
loadBalancerServiceReplace
object
Load Balancer Service.
10 properties 3 required
loadBalancerProxyProtocolVersionOrDisabled
stringnull
Empty string means disabled
loadBalancerBackendCreate
object
Load Balancer Backend
5 properties 2 required
loadBalancerActionHttpRedirectCreate
Forwarding rule HTTP Redirect action
loadBalancerServiceConfiguredStatus
string
Service configured status
loadBalancerContentTypes
string
Content types
loadBalancerCertificateBundleAuthorityModify
object
Load Balancer certificate bundle dynamic type
3 properties
loadBalancerPlansResponse
array
List of available load balancer plans, each defining the node size, performance characteristics, and associated pricing options.
loadBalancerCertificateBundle
object
Represents a certificate bundle used in a load balancer TLS configuration. A bundle may be manually uploaded, dynamically issued via ACME, or represent an auth…
15 properties 6 required
loadBalancerBackendMetricsSeries
object
Aggregated performance, availability, and traffic statistics for a load balancer backend, including member metrics and average timing metrics.
22 properties 3 required
loadBalancerMatcherIpCreate
object
Forwarding rule IP matcher for matching source IP addresses. Accepts IPv4, IPv6 addresses or CIDR notation.
1 property 1 required
loadBalancerMatcherResponse
object
Defines a matcher used to evaluate specific conditions in requests or responses.
17 properties 2 required
loadBalancerFrontendMode
string
Mode
loadBalancerRule
object
Represents a load balancer rule that defines how incoming traffic is matched and processed by a frontend, including priority, matching conditions, and actions…
7 properties 7 required
loadBalancerResolver
object
Represents a DNS resolver configuration for a load balancer service, defining the nameservers, retry behavior, and caching rules used to resolve backend hostna…
9 properties 9 required
loadBalancerResolverModify
object
Load Balancer Resolver
7 properties
loadBalancerCertificateBundleManualModify
object
Load Balancer certificate bundle manual type
5 properties
loadBalancerAvgTimeMetricsResponse
object
Represents average timing statistics for backend performance, including connection establishment, queuing, server response, and total transaction times, all me…
4 properties 4 required
loadBalancerCertificateBundleParameter
string
The UUID of the certificate bundle.
loadBalancerNetworkCreate
object
Load Balancer Network.
4 properties 3 required
loadBalancerTlsConfigParameter
string
The name of the TLS configuration.
loadBalancerActionSetHeaderCreate
object
Forwarding rule HTTP set header action
2 properties 1 required
loadBalancerFrontendMetricsSeriesResponse
array
Response schema for a list of frontend metrics series.
loadBalancerRequestMetricsResponse
object
Represents basic HTTP request statistics collected by the load balancer, including the total number of processed, denied, and intercepted requests.
3 properties 3 required
loadBalancerActionHttpReturnCreate
object
Forwarding rule HTTP Return action
3 properties 3 required
loadBalancerEmbeddedFrontendResponse
object
Represents a minimal embedded reference to a frontend within a load balancer service, including its name and any associated TLS configurations.
2 properties 1 required
loadBalancerMatcherIntCreate
object
Forwarding rule integer matcher
4 properties 1 required
loadBalancerTlsConfigModify
object
Load Balancer TLS Config
2 properties
loadBalancerMatcherStringArgCreate
Forwarding rule string matcher
loadBalancerBackendsResponse
array
Response schema for a list of backends.
loadBalancerFrontendParameter
string
The name of the frontend.
loadBalancerLabelResponse
object
Represents a key-value label associated with the load balancer service
2 properties 1 required
loadBalancerNetworkFamily
string
Network family
loadBalancerPlanParameter
string
The name of the plan.
loadBalancerMemberModify
object
Load Balancer backend member
9 properties
loadBalancerMemberMetricsSeriesResponse
object
Aggregated time-series metrics for backend members, showing request and response statistics, connection health, and server performance during a given time wind…
23 properties 3 required
loadBalancerActionSetForwardedHeaders
object
Forwarding rule Set forwarded headers
loadBalancerCertificatesBundleResponse
array
Response schema for a list of certificate bundles.
loadBalancerEmbeddedBackendResponse
object
Represents a minimal embedded reference to a backend within the load balancer service, including its name and associated TLS configurations.
2 properties 1 required
loadBalancerServiceParameter
string
The UUID of the service.
loadBalancerRuleModify
object
Load Balancer Forwarding Rule
5 properties
loadBalancerErrorResponse
object
Schema for error responses from the API.
1 property
loadBalancerActionSetForwardedHeadersResponse
object
Defines an action that automatically adds standard X-Forwarded- headers (such as X-Forwarded-For and X-Forwarded-Proto) to requests before forwarding them to t…
loadBalancerFrontendCreate
object
Load Balancer Frontend
8 properties 4 required
loadBalancerCommonMetricsResponse
object
Represents general traffic and session statistics collected for a load balancer frontend or backend, including request and response byte counts, HTTP status di…
12 properties 12 required
loadBalancerMaintenanceDayOfWeek
string
Day of week
loadBalancerMatcherHttpMethodCreate
object
Forwarding rule HTTP method matcher
1 property 1 required
loadBalancerMemberMetricsResponse
object
Represents detailed performance and health metrics for an individual backend member (server) within a load balancer. Includes operational status, health check…
11 properties 9 required
loadBalancerNetworkModify
object
Load Balancer Network
1 property
loadBalancerActionHttpRewritePathCreate
object
Rewrite HTTP request path using regex pattern
2 properties 2 required
loadBalancerFrontendNetworkCreate
object
Load Balancer Network
1 property 1 required
loadBalancerCertificateBundleDynamicModify
object
Load Balancer certificate bundle dynamic type
4 properties
loadBalancerBackend
object
Represents a backend configuration in the load balancer service, containing backend members, resolver settings, TLS configurations, and backend-specific proper…
7 properties 6 required
loadBalancerMatcherHostCreate
object
Forwarding rule host matcher
1 property 1 required
loadBalancerTlsConfigCreate
object
Load Balancer TLS Config
2 properties 2 required
loadBalancerBackendMetricsSeriesResponse
array
Response schema for a list of backend metrics series.
loadBalancerActionTcpRejectCreate
object
Forwarding rule TCP reject action
loadBalancerBackendPropertiesCreate
object
Backend Properties
17 properties
loadBalancerFrontendPropertiesCreate
object
Frontend Properties
3 properties
loadBalancerRulesResponse
array
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associa…
loadBalancerRuleParameter
string
The name of the rule.
loadBalancerStringMatcherMethods
string
String matcher methods
loadBalancerService
object
Represents a load balancer service instance that groups together frontends, backends, and related agents. It defines the service plan, network configuration, a…
18 properties 7 required
loadBalancerTlsConfigsResponse
array
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
loadBalancerProblemResponse
object
Represents an error object following the Problem Details specification (RFC7807). Provides machine-readable and human-readable information about an error that…
6 properties 3 required
loadBalancerLabelFilterParameter
array
Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.
loadBalancerFrontendsResponse
array
An array of frontend configurations for a load balancer service.
loadBalancerStringMatcherMethodsNoValue
string
String matcher methods (no value)
loadBalancerFrontendTlsConfigsResponse
array
Represents a list of TLS configurations for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
loadBalancerMember
object
Represents a single backend member (server node) participating in a load balancer backend configuration.
10 properties 10 required
loadBalancerOffsetParameter
integer
Offset for retrieved results.
loadBalancerServiceModify
object
Load Balancer Service
10 properties
loadBalancerMetrics
object
Represents a snapshot of load balancer metrics collected by the monitoring agent, including frontend and backend statistics for a given service at a specific t…
2 properties 2 required
loadBalancerBackendMetricsResponse
object
Represents collected performance, availability, and traffic statistics for a load balancer backend, including member activity, response times, and aggregated s…
8 properties 8 required
loadBalancerTlsConfig
object
Represents a TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
4 properties 4 required
loadBalancerFrontendMetricsSeries
object
Aggregated time-series metrics for load balancer frontends, representing cumulative statistics between a start and end timestamp across one or more frontend in…
19 properties 3 required
loadBalancerMatchBackendResponse
Defines a backend health matcher used to compare the number of healthy (up) members in a specific backend against a threshold value. Used when the matcher type…
loadBalancerResolverCreate
object
Load Balancer Resolver
7 properties 7 required
loadBalancerHttpMethods
string
HTTP methods
loadBalancerActionTcpRejectResponse
object
Defines a TCP rejection action that immediately closes incoming connections when a rule matches. Used when the action type is 'tcpreject'.
loadBalancerActionSetHeaderResponse
object
Defines an action that adds or modifies an HTTP header in a request or response. Used when the action type is 'setrequestheader' or 'setresponseheader'.
2 properties 2 required
loadBalancerProblemInvalidParamResponse
object
Provides detailed information about a specific invalid parameter that caused a request to fail validation, as an extension of RFC7807 Problem Details.
2 properties 2 required
loadBalancerMetricsSortParameter
string
Sort metrics by field. Prefix with '-' for descending order.
loadBalancerMatchStringResponse
object
Defines a string-based match condition, used for matching values such as paths, headers, URLs, or hostnames.
3 properties
loadBalancerActionHttpReturnResponse
object
Defines a custom HTTP response returned to the client when a rule matches. Used when the action type is 'httpreturn'.
3 properties 3 required
loadBalancerLimitParameter
integer
Number of entries to receive at most.
loadBalancerMetricsSeriesResponse
array
Response schema for a mapping of metric series identifiers to their corresponding metrics data.
loadBalancerMemberParameter
string
The name of the member.
loadBalancerServiceLabelsResponse
array
Represents a list of key-value label associated with the load balancer service
loadBalancerLabelParameter
string
The label key parameter.
loadBalancerDnsChallengeDomainResponse
object
Response schema for DNS challenge domain information.
1 property 1 required
loadBalancerActionUseBackendResponse
object
Defines the backend target to which the request should be routed when the rule matches. Used when the action type is 'usebackend'.
1 property 1 required
loadBalancerIpAddressCreate
object
IP address object
2 properties 1 required
loadBalancerMatcherCreate
Load Balancer Forwarding Rule Matcher
loadBalancerServiceCreate
object
Load Balancer Service
13 properties 5 required
loadBalancerFrontendMetricsResponse
object
Represents aggregated performance and traffic metrics for a load balancer frontend, including connection statistics, HTTP response counts, and per-second reque…
8 properties 8 required
loadBalancerHealthCheckType
string
Health check type
loadBalancerMemberCreate
object
Load Balancer backend member
9 properties
loadBalancerFrontendPropertiesResponse
object
Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.
4 properties 2 required
loadBalancerNetworkParameter
string
The name of the network.
loadBalancerActionCreate
Load Balancer Forwarding Rule Action
loadBalancerActionHttpRewritePathResponse
object
Defines an action that rewrites the HTTP request path using a regex pattern.
2 properties 2 required
loadBalancerPlan
object
Represents a load balancer plan, defining the node size, performance characteristics, and associated pricing options.
3 properties
loadBalancerBackendModify
object
Load Balancer Backend
5 properties
loadBalancerMatchingCondition
string
Defines how multiple matching criteria are combined to evaluate a condition.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-load-balancer-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Kubernetes API
Where this information came from

This is an independent, third-party profile of UpCloud Load Balancer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.