Load Balancer
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.
List load balancers
Returns a list of available load balancer services.
query Parameters
limitNumber of entries to receive at most.
Number of entries to receive at most.
offsetOffset for retrieved results.
Offset for retrieved results.
sortSort resources by field. Prefix with '-' for descending order.
Sort services by field. Prefix with '-' for descending order.
labelFilter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.
Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.
List load balancers › Responses
Created
Response schema for a list of services.
uuidUnique identifier of the service.
nameHuman-readable name assigned to the service.
zoneUpCloud zone where the service is deployed.
planSelected load balancer plan defining node size, performance, and pricing tier.
configured_statusConfiguration status of the service (e.g., whether all components are correctly provisioned).
created_atTimestamp when the service was created.
updated_atTimestamp when the service was last updated.
operational_stateCurrent operational state of the service, describing its runtime behavior and availability.
List of frontend configurations associated with the service.
List of backend configurations linked to this service.
DNS resolvers available for this service.
Networks attached to this service.
IP addresses assigned to this service.
Labels associated with the service for metadata tagging and identification.
maintenance_dowDay of week scheduled for maintenance operations.
maintenance_timeTime of day (in UTC) scheduled for maintenance operations.
network_uuidDeprecated: old field replaced by the networks array.
dns_nameDeprecated: legacy DNS field replaced by service-level IP addressing.
Create load balancer
Creates a new load balancer service.
Create load balancer › Request Body
nameName of the service
zone^[a-z]{2}-[a-z]{3}\d… · requiredZone
planPlan
configured_statusService configured status
Service frontends
Service backends
Service resolvers
network_uuidPrivate Network UUID
Service networks
Labels
maintenance_dowDay of week
maintenance_time^(0[0-9]|1[0-9]|2[0-…Maintenance time
List of IP addresses for the network
Create load balancer › Responses
Created
uuidUnique identifier of the service.
nameHuman-readable name assigned to the service.
zoneUpCloud zone where the service is deployed.
planSelected load balancer plan defining node size, performance, and pricing tier.
configured_statusConfiguration status of the service (e.g., whether all components are correctly provisioned).
created_atTimestamp when the service was created.
updated_atTimestamp when the service was last updated.
operational_stateCurrent operational state of the service, describing its runtime behavior and availability.
List of frontend configurations associated with the service.
List of backend configurations linked to this service.
DNS resolvers available for this service.
Networks attached to this service.
IP addresses assigned to this service.
Labels associated with the service for metadata tagging and identification.
maintenance_dowDay of week scheduled for maintenance operations.
maintenance_timeTime of day (in UTC) scheduled for maintenance operations.
network_uuidDeprecated: old field replaced by the networks array.
dns_nameDeprecated: legacy DNS field replaced by service-level IP addressing.
Get load balancer
Returns load balancer service details by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Get load balancer › Responses
Created
uuidUnique identifier of the service.
nameHuman-readable name assigned to the service.
zoneUpCloud zone where the service is deployed.
planSelected load balancer plan defining node size, performance, and pricing tier.
configured_statusConfiguration status of the service (e.g., whether all components are correctly provisioned).
created_atTimestamp when the service was created.
updated_atTimestamp when the service was last updated.
operational_stateCurrent operational state of the service, describing its runtime behavior and availability.
List of frontend configurations associated with the service.
List of backend configurations linked to this service.
DNS resolvers available for this service.
Networks attached to this service.
IP addresses assigned to this service.
Labels associated with the service for metadata tagging and identification.
maintenance_dowDay of week scheduled for maintenance operations.
maintenance_timeTime of day (in UTC) scheduled for maintenance operations.
network_uuidDeprecated: old field replaced by the networks array.
dns_nameDeprecated: legacy DNS field replaced by service-level IP addressing.
Replace load balancer
Replaces existing load balancer service by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Replace load balancer › Request Body
nameName of the service
planPlan
configured_statusService configured status
Service frontends
Service backends
Service resolvers
Labels
maintenance_dowDay of week
maintenance_time^(0[0-9]|1[0-9]|2[0-…Maintenance time
List of IP addresses for the network
Replace load balancer › Responses
Created
uuidUnique identifier of the service.
nameHuman-readable name assigned to the service.
zoneUpCloud zone where the service is deployed.
planSelected load balancer plan defining node size, performance, and pricing tier.
configured_statusConfiguration status of the service (e.g., whether all components are correctly provisioned).
created_atTimestamp when the service was created.
updated_atTimestamp when the service was last updated.
operational_stateCurrent operational state of the service, describing its runtime behavior and availability.
List of frontend configurations associated with the service.
List of backend configurations linked to this service.
DNS resolvers available for this service.
Networks attached to this service.
IP addresses assigned to this service.
Labels associated with the service for metadata tagging and identification.
maintenance_dowDay of week scheduled for maintenance operations.
maintenance_timeTime of day (in UTC) scheduled for maintenance operations.
network_uuidDeprecated: old field replaced by the networks array.
dns_nameDeprecated: legacy DNS field replaced by service-level IP addressing.
Delete load balancer
Deletes existing load balancer service by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Delete load balancer › Responses
No Content
Modify load balancer
Modifies existing load balancer service by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Modify load balancer › Request Body
nameName of the service
planPlan
configured_statusService configured status
Service frontends
Service backends
Service resolvers
Labels
maintenance_dowDay of week
maintenance_time^(0[0-9]|1[0-9]|2[0-…Maintenance time
List of IP addresses for the network
Modify load balancer › Responses
Created
uuidUnique identifier of the service.
nameHuman-readable name assigned to the service.
zoneUpCloud zone where the service is deployed.
planSelected load balancer plan defining node size, performance, and pricing tier.
configured_statusConfiguration status of the service (e.g., whether all components are correctly provisioned).
created_atTimestamp when the service was created.
updated_atTimestamp when the service was last updated.
operational_stateCurrent operational state of the service, describing its runtime behavior and availability.
List of frontend configurations associated with the service.
List of backend configurations linked to this service.
DNS resolvers available for this service.
Networks attached to this service.
IP addresses assigned to this service.
Labels associated with the service for metadata tagging and identification.
maintenance_dowDay of week scheduled for maintenance operations.
maintenance_timeTime of day (in UTC) scheduled for maintenance operations.
network_uuidDeprecated: old field replaced by the networks array.
dns_nameDeprecated: legacy DNS field replaced by service-level IP addressing.
List load balancer frontends
Returns a list of available service frontends by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
List load balancer frontends › Responses
Created
An array of frontend configurations for a load balancer service.
nameHuman-readable name assigned to the frontend.
portPort number on which the frontend listens for incoming connections.
modeOperating mode defining the protocol layer at which the frontend operates.
default_backendName of the backend used when no routing rules match the incoming request.
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.
Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.
created_atTimestamp when the frontend was created (RFC 3339 format).
updated_atTimestamp when the frontend was last updated (RFC 3339 format).
Create load balancer frontend
Creates a new service frontend by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Create load balancer frontend › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the frontend
portPort to listen
modeMode
default_backend^[a-zA-Z0-9_-]+$ · requiredDefault backend
Network names
TLS Configs
Rules
Frontend Properties
Create load balancer frontend › Responses
Created
nameHuman-readable name assigned to the frontend.
portPort number on which the frontend listens for incoming connections.
modeOperating mode defining the protocol layer at which the frontend operates.
default_backendName of the backend used when no routing rules match the incoming request.
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.
Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.
created_atTimestamp when the frontend was created (RFC 3339 format).
updated_atTimestamp when the frontend was last updated (RFC 3339 format).
Get load balancer frontend
Returns service frontend details by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
Get load balancer frontend › Responses
Created
nameHuman-readable name assigned to the frontend.
portPort number on which the frontend listens for incoming connections.
modeOperating mode defining the protocol layer at which the frontend operates.
default_backendName of the backend used when no routing rules match the incoming request.
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.
Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.
created_atTimestamp when the frontend was created (RFC 3339 format).
updated_atTimestamp when the frontend was last updated (RFC 3339 format).
Delete load balancer frontend
Deletes existing frontend by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
Delete load balancer frontend › Responses
No Content
Modify load balancer frontend
Modifies existing service frontend by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
Modify load balancer frontend › Request Body
name^[a-zA-Z0-9_-]+$Name of the frontend
portPort to listen
modeMode
default_backend^[a-zA-Z0-9_-]+$Default backend
Frontend Properties
Network names
TLS Configs
Rules
Modify load balancer frontend › Responses
Created
nameHuman-readable name assigned to the frontend.
portPort number on which the frontend listens for incoming connections.
modeOperating mode defining the protocol layer at which the frontend operates.
default_backendName of the backend used when no routing rules match the incoming request.
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.
Defines configurable properties for a frontend, such as client timeout settings, protocol options, and linkage to its parent frontend resource.
created_atTimestamp when the frontend was created (RFC 3339 format).
updated_atTimestamp when the frontend was last updated (RFC 3339 format).
List load balancer frontend TLS configs
Returns a list of available frontend TLS configs by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
List load balancer frontend TLS configs › Responses
Created
Represents a list of TLS configurations for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Create load balancer frontend TLS config
Creates a new TLS config by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
Create load balancer frontend TLS config › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the config
certificate_bundle_uuidCertificate Bundle UUID
Create load balancer frontend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Get load balancer frontend TLS config
Returns frontend TLS config details by given {service-uuid}, {frontend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Get load balancer frontend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Delete load balancer frontend TLS config
Deletes existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Delete load balancer frontend TLS config › Responses
No Content
Modify load balancer frontend TLS config
Modifies existing TLS config by given {service-uuid}, {frontend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Modify load balancer frontend TLS config › Request Body
name^[a-zA-Z0-9_-]+$Name of the config
certificate_bundle_uuidCertificate Bundle UUID
Modify load balancer frontend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
List load balancer rules
Returns a list of available frontend rules by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
List load balancer rules › Responses
Created
Represents a list of load balancer rules that define how incoming requests are matched and processed, including conditions, actions, and backend target associations.
nameHuman-readable name assigned to the routing rule.
priorityPriority order for rule evaluation, where lower values indicate higher priority.
matching_conditionLogical operator determining how multiple matchers are combined (and/or).
List of conditions that incoming requests must satisfy for this rule to apply.
List of actions to execute when the rule matches an incoming request.
created_atTimestamp when the rule was created (RFC 3339 format).
updated_atTimestamp when the rule was last updated (RFC 3339 format).
Create load balancer rule
Creates a new rule by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
Create load balancer rule › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the rule
priorityPriority
matchersRule matchers
Rule actions
matching_conditionDefines how multiple matching criteria are combined to evaluate a condition.
Create load balancer rule › Responses
Created
nameHuman-readable name assigned to the routing rule.
priorityPriority order for rule evaluation, where lower values indicate higher priority.
matching_conditionLogical operator determining how multiple matchers are combined (and/or).
List of conditions that incoming requests must satisfy for this rule to apply.
List of actions to execute when the rule matches an incoming request.
created_atTimestamp when the rule was created (RFC 3339 format).
updated_atTimestamp when the rule was last updated (RFC 3339 format).
Get load balancer rule
Returns frontend rule details by given {service-uuid}, {frontend-name}, and {rule-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
rule-nameThe unique identifier for the rule.
The name of the rule.
Get load balancer rule › Responses
Created
nameHuman-readable name assigned to the routing rule.
priorityPriority order for rule evaluation, where lower values indicate higher priority.
matching_conditionLogical operator determining how multiple matchers are combined (and/or).
List of conditions that incoming requests must satisfy for this rule to apply.
List of actions to execute when the rule matches an incoming request.
created_atTimestamp when the rule was created (RFC 3339 format).
updated_atTimestamp when the rule was last updated (RFC 3339 format).
Replace load balancer rule
Replaces existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
rule-nameThe unique identifier for the rule.
The name of the rule.
Replace load balancer rule › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the rule
priorityPriority
matchersRule matchers
Rule actions
matching_conditionDefines how multiple matching criteria are combined to evaluate a condition.
Replace load balancer rule › Responses
Created
nameHuman-readable name assigned to the routing rule.
priorityPriority order for rule evaluation, where lower values indicate higher priority.
matching_conditionLogical operator determining how multiple matchers are combined (and/or).
List of conditions that incoming requests must satisfy for this rule to apply.
List of actions to execute when the rule matches an incoming request.
created_atTimestamp when the rule was created (RFC 3339 format).
updated_atTimestamp when the rule was last updated (RFC 3339 format).
Delete load balancer rule
Deletes existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
rule-nameThe unique identifier for the rule.
The name of the rule.
Delete load balancer rule › Responses
No Content
Modify load balancer rule
Modifies existing rule by given {service-uuid}, {frontend-name}, and {rule-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
rule-nameThe unique identifier for the rule.
The name of the rule.
Modify load balancer rule › Request Body
name^[a-zA-Z0-9_-]+$Name of the rule
priorityPriority
matching_conditionDefines how multiple matching criteria are combined to evaluate a condition.
matchersRule matchers
Rule actions
Modify load balancer rule › Responses
Created
nameHuman-readable name assigned to the routing rule.
priorityPriority order for rule evaluation, where lower values indicate higher priority.
matching_conditionLogical operator determining how multiple matchers are combined (and/or).
List of conditions that incoming requests must satisfy for this rule to apply.
List of actions to execute when the rule matches an incoming request.
created_atTimestamp when the rule was created (RFC 3339 format).
updated_atTimestamp when the rule was last updated (RFC 3339 format).
List load balancer backends
Returns a list of available service backends by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
List load balancer backends › Responses
Created
Response schema for a list of backends.
nameHuman-readable name of the backend
List of backend member servers (nodes) participating in this backend configuration.
TLS configurations associated with this backend, specifying certificate bundles and identifiers.
Properties of a backend configuration.
created_atTimestamp when the backend was created (RFC 3339 format).
updated_atTimestamp when the backend was last updated (RFC 3339 format).
resolverOptional outbound DNS resolver reference used by this backend. Null when not set.
Create load balancer backend
Creates a new backend by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Create load balancer backend › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the backend
Backend members
TLS Configs
Resolver reference
Backend Properties
Create load balancer backend › Responses
Created
nameHuman-readable name of the backend
List of backend member servers (nodes) participating in this backend configuration.
TLS configurations associated with this backend, specifying certificate bundles and identifiers.
Properties of a backend configuration.
created_atTimestamp when the backend was created (RFC 3339 format).
updated_atTimestamp when the backend was last updated (RFC 3339 format).
resolverOptional outbound DNS resolver reference used by this backend. Null when not set.
Get load balancer backend
Returns service backend details by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
Get load balancer backend › Responses
Created
nameHuman-readable name of the backend
List of backend member servers (nodes) participating in this backend configuration.
TLS configurations associated with this backend, specifying certificate bundles and identifiers.
Properties of a backend configuration.
created_atTimestamp when the backend was created (RFC 3339 format).
updated_atTimestamp when the backend was last updated (RFC 3339 format).
resolverOptional outbound DNS resolver reference used by this backend. Null when not set.
Delete load balancer backend
Deletes existing backend by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
Delete load balancer backend › Responses
No Content
Modify load balancer backend
Modifies existing backend by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
Modify load balancer backend › Request Body
name^[a-zA-Z0-9_-]+$Name of the backend
Backend members
TLS Configs
Resolver reference
Backend Properties
Modify load balancer backend › Responses
Created
nameHuman-readable name of the backend
List of backend member servers (nodes) participating in this backend configuration.
TLS configurations associated with this backend, specifying certificate bundles and identifiers.
Properties of a backend configuration.
created_atTimestamp when the backend was created (RFC 3339 format).
updated_atTimestamp when the backend was last updated (RFC 3339 format).
resolverOptional outbound DNS resolver reference used by this backend. Null when not set.
List load balancer members
Returns a list of available backend members by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
List load balancer members › Responses
Created
Response schema for a list of members.
nameHuman-readable name assigned to the backend member.
ipIP address of the backend member server.
portPort number on which the backend member server listens.
weightRelative weight for load balancing, determining the proportion of requests sent to this member.
max_sessionsMaximum number of concurrent connections allowed to this backend member.
typeType of backend configuration. Allowed values are 'static' and 'dynamic'.
enabledIndicates whether the backend member is actively participating in load balancing.
backupIndicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.
created_atTimestamp when the backend member was created (RFC 3339 format).
updated_atTimestamp when the backend member was last updated (RFC 3339 format).
Create load balancer member
Creates a new member by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
Create load balancer member › Request Body
nameName of the member
server_uuidTarget server UUID
weightTarget weight
max_sessionsMaximum number of sessions before queueing
typeMember type
enabledIs member enabled
backupIs backup member
ipIP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members.
portPort number on which the backend member server listens.
Decision Table
| Variant | Matching Criteria |
|---|---|
| requires: name, ip, port +4 more | |
| requires: name, weight, max_sessions +2 more |
typeTarget IP address (IPv4 or IPv6)
portTarget Port
Create load balancer member › Responses
Created
nameHuman-readable name assigned to the backend member.
ipIP address of the backend member server.
portPort number on which the backend member server listens.
weightRelative weight for load balancing, determining the proportion of requests sent to this member.
max_sessionsMaximum number of concurrent connections allowed to this backend member.
typeType of backend configuration. Allowed values are 'static' and 'dynamic'.
enabledIndicates whether the backend member is actively participating in load balancing.
backupIndicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.
created_atTimestamp when the backend member was created (RFC 3339 format).
updated_atTimestamp when the backend member was last updated (RFC 3339 format).
Get load balancer member
Returns backend member details by given {service-uuid}, {backend-name} and {member-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
member-nameThe unique identifier for the member.
The name of the member.
Get load balancer member › Responses
Created
nameHuman-readable name assigned to the backend member.
ipIP address of the backend member server.
portPort number on which the backend member server listens.
weightRelative weight for load balancing, determining the proportion of requests sent to this member.
max_sessionsMaximum number of concurrent connections allowed to this backend member.
typeType of backend configuration. Allowed values are 'static' and 'dynamic'.
enabledIndicates whether the backend member is actively participating in load balancing.
backupIndicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.
created_atTimestamp when the backend member was created (RFC 3339 format).
updated_atTimestamp when the backend member was last updated (RFC 3339 format).
Delete load balancer member
Deletes existing member by given {service-uuid}, {backend-name} and {member-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
member-nameThe unique identifier for the member.
The name of the member.
Delete load balancer member › Responses
No Content
Modify load balancer member
Modifies existing member by given {service-uuid}, {backend-name} and {member-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
member-nameThe unique identifier for the member.
The name of the member.
Modify load balancer member › Request Body
nameName of the member
server_uuidTarget server UUID
weightTarget weight
max_sessionsMaximum number of sessions before queueing
typeMember type
enabledIs member enabled
backupIs backup member
ipIP address of the backend member server. Depending on the member type, this can be an IPv4 address, IPv6 address, or a domain name for dynamic members.
portPort number on which the backend member server listens.
Decision Table
| Variant | Matching Criteria |
|---|---|
| No specific criteria | |
| requires: type |
typeTarget IP address (IPv4 or IPv6)
portTarget Port
Modify load balancer member › Responses
Created
nameHuman-readable name assigned to the backend member.
ipIP address of the backend member server.
portPort number on which the backend member server listens.
weightRelative weight for load balancing, determining the proportion of requests sent to this member.
max_sessionsMaximum number of concurrent connections allowed to this backend member.
typeType of backend configuration. Allowed values are 'static' and 'dynamic'.
enabledIndicates whether the backend member is actively participating in load balancing.
backupIndicates whether this member serves as a backup, only receiving traffic when all primary members are unavailable.
created_atTimestamp when the backend member was created (RFC 3339 format).
updated_atTimestamp when the backend member was last updated (RFC 3339 format).
List load balancer backend TLS configs
Returns a list of available backend TLS configs by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
List load balancer backend TLS configs › Responses
Created
Represents a list of TLS configuration for a frontend or backend, defining the certificate bundle and associated identifiers within the load balancer service.
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Create load balancer backend TLS config
Creates a new TLS config by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
Create load balancer backend TLS config › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the config
certificate_bundle_uuidCertificate Bundle UUID
Create load balancer backend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Get load balancer backend TLS config
Returns backend TLS config details by given {service-uuid}, {backend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Get load balancer backend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Delete load balancer backend TLS config
Deletes existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Delete load balancer backend TLS config › Responses
No Content
Modify load balancer backend TLS config
Modifies existing TLS config by given {service-uuid}, {backend-name}, and {tls-config-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
tls-config-nameThe unique identifier for the TLS configuration.
The name of the TLS configuration.
Modify load balancer backend TLS config › Request Body
name^[a-zA-Z0-9_-]+$Name of the config
certificate_bundle_uuidCertificate Bundle UUID
Modify load balancer backend TLS config › Responses
Created
nameHuman-readable name assigned to the TLS configuration.
certificate_bundle_uuidUUID of the certificate bundle used for TLS encryption.
created_atTimestamp when the TLS configuration was created (RFC 3339 format).
updated_atTimestamp when the TLS configuration was last updated (RFC 3339 format).
Modify load balancer network
Modifies existing service network by given {service-uuid} and {network-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
network-nameThe unique identifier for the network.
The name of the network.
Modify load balancer network › Request Body
name^[a-zA-Z0-9_-]+$Name of the network
Modify load balancer network › Responses
Created
nameHuman-readable name assigned to the network.
uuidUUID represented as a string
typeNetwork type indicating the visibility scope (public or private).
familyIP address family used by this network (IPv4 or IPv6).
created_atTimestamp when the network was created (RFC 3339 format).
updated_atTimestamp when the network was last updated (RFC 3339 format).
dns_nameFully qualified domain name (FQDN) for accessing the load balancer through this network.
List load balancer IP addresses
Returns a list of available IP addresses by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
List load balancer IP addresses › Responses
Created
A list of floating public IPv4 addresses attached to the load balancer service, each including its network interface metadata.
addressIP address assigned to the load balancer service on this network.
network_nameName of the network to which this IP address belongs.
created_atTimestamp when the IP address was created (RFC 3339 format).
updated_atTimestamp when the IP address was last updated (RFC 3339 format).
Create load balancer IP address
Attach a floating public IPv4 address to the service using the specified {service-uuid}. The number of attachable floating IPv4 addresses is limited to the number of nodes in the plan, and all addresses must be in the same zone as the service and detached.
Note: Floating public IPv4 addresses have configurable release policies. When the service is deleted or an IP address is detached, addresses with the keep policy will be converted to detached floating IPs that remain available in your account. Addresses with the release policy will be automatically deleted. For more details, see IP Addresses.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Create load balancer IP address › Request Body
addressIP address
network_name^[a-zA-Z0-9_-]+$Name of the target network
Create load balancer IP address › Responses
Created
addressIP address assigned to the load balancer service on this network.
network_nameName of the network to which this IP address belongs.
created_atTimestamp when the IP address was created (RFC 3339 format).
updated_atTimestamp when the IP address was last updated (RFC 3339 format).
Get load balancer IP address
Returns IP address details by given {service-uuid} and {ip-address}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
ip-addressThe unique identifier for the IP address.
The IP address parameter.
Get load balancer IP address › Responses
Created
A list of floating public IPv4 addresses attached to the load balancer service, each including its network interface metadata.
addressIP address assigned to the load balancer service on this network.
network_nameName of the network to which this IP address belongs.
created_atTimestamp when the IP address was created (RFC 3339 format).
updated_atTimestamp when the IP address was last updated (RFC 3339 format).
Delete load balancer IP address
Detach a floating public IPv4 address from the service by given {service-uuid} and {address}. Depending on the release policy, the customer retains the floating IP if the policy is set to keep. If the policy is set to release, the floating IP will be deleted.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
ip-addressThe unique identifier for the IP address.
The IP address parameter.
Delete load balancer IP address › Responses
No Content
List load balancer resolvers
Returns a list of available service domain name resolvers by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
List load balancer resolvers › Responses
Created
Represents a list of DNS resolver configurations for a load balancer service.
nameHuman-readable name assigned to the DNS resolver.
nameserversList of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.
retriesNumber of retry attempts for failed DNS queries.
timeoutInitial timeout in milliseconds for DNS query responses.
timeout_retryTimeout in milliseconds for DNS query retry attempts.
cache_validTime in seconds to cache valid (successful) DNS responses.
cache_invalidTime in seconds to cache invalid (failed) DNS responses.
created_atTimestamp when the DNS resolver was created (RFC 3339 format).
updated_atTimestamp when the DNS resolver was last updated (RFC 3339 format).
Create load balancer resolver
Creates a new resolver by given {service-uuid}.
Resolver is a DNS server usually residing in a user's private network. It's used to resolve IPs for backend members of type dynamic.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Create load balancer resolver › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the resolver
nameserversNameservers
retriesNumber of retries on failure
timeoutTimeout for the query in seconds
timeout_retryTimeout for the query retries in seconds
cache_validTime in seconds to cache valid results
cache_invalidTime in seconds to cache invalid results
Create load balancer resolver › Responses
Created
nameHuman-readable name assigned to the DNS resolver.
nameserversList of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.
retriesNumber of retry attempts for failed DNS queries.
timeoutInitial timeout in milliseconds for DNS query responses.
timeout_retryTimeout in milliseconds for DNS query retry attempts.
cache_validTime in seconds to cache valid (successful) DNS responses.
cache_invalidTime in seconds to cache invalid (failed) DNS responses.
created_atTimestamp when the DNS resolver was created (RFC 3339 format).
updated_atTimestamp when the DNS resolver was last updated (RFC 3339 format).
Get load balancer resolver
Returns backend resolver details by given {service-uuid} and {resolver-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
resolver-nameThe unique identifier for the resolver.
The name of the resolver.
Get load balancer resolver › Responses
Created
nameHuman-readable name assigned to the DNS resolver.
nameserversList of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.
retriesNumber of retry attempts for failed DNS queries.
timeoutInitial timeout in milliseconds for DNS query responses.
timeout_retryTimeout in milliseconds for DNS query retry attempts.
cache_validTime in seconds to cache valid (successful) DNS responses.
cache_invalidTime in seconds to cache invalid (failed) DNS responses.
created_atTimestamp when the DNS resolver was created (RFC 3339 format).
updated_atTimestamp when the DNS resolver was last updated (RFC 3339 format).
Delete load balancer resolver
Deletes existing resolver by given {service-uuid} and {resolver-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
resolver-nameThe unique identifier for the resolver.
The name of the resolver.
Delete load balancer resolver › Responses
No Content
Modify load balancer resolver
Modifies existing resolver by given {service-uuid} and {resolver-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
resolver-nameThe unique identifier for the resolver.
The name of the resolver.
Modify load balancer resolver › Request Body
name^[a-zA-Z0-9_-]+$Name of the resolver
nameserversNameservers
retriesNumber of retries on failure
timeoutTimeout for the query in seconds
timeout_retryTimeout for the query retries in seconds
cache_validTime in seconds to cache valid results
cache_invalidTime in seconds to cache invalid results
Modify load balancer resolver › Responses
Created
nameHuman-readable name assigned to the DNS resolver.
nameserversList of DNS nameserver addresses (with optional port) used to resolve backend member hostnames.
retriesNumber of retry attempts for failed DNS queries.
timeoutInitial timeout in milliseconds for DNS query responses.
timeout_retryTimeout in milliseconds for DNS query retry attempts.
cache_validTime in seconds to cache valid (successful) DNS responses.
cache_invalidTime in seconds to cache invalid (failed) DNS responses.
created_atTimestamp when the DNS resolver was created (RFC 3339 format).
updated_atTimestamp when the DNS resolver was last updated (RFC 3339 format).
List load balancer labels
Returns a list of available service labels by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
List load balancer labels › Responses
Created
Represents a list of key-value label associated with the load balancer service
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Create load balancer label
Creates a new label by given {service-uuid}.
Labels used for service filtering.
Service labels usage examples Below are some examples of what certain GET requests might look like.
exact match: GET /1.3/load-balancer?label=env%3Dstaging existence: GET /1.3/load-balancer?label=env multiple: GET /1.3/load-balancer?label=env&label=foo%3Dbar
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Create load balancer label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredKey
value\A[\p{L}\p{N}\p{P}\p… · requiredValue
Create load balancer label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Get load balancer label
Returns label details by given {service-uuid} and {label-key}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
label-keyThe unique identifier for the label.
The label key parameter.
Get load balancer label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Delete load balancer label
Deletes existing label by given {service-uuid} and {label-key}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
label-keyThe unique identifier for the label.
The label key parameter.
Delete load balancer label › Responses
No Content
Modify load balancer label
Modifies existing label by given {service-uuid} and {label-key}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
label-keyThe unique identifier for the label.
The label key parameter.
Modify load balancer label › Request Body
key^[\x20-\x5E\x60-\x7E…Key
value\A[\p{L}\p{N}\p{P}\p…Value
Modify load balancer label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Get load balancer metrics
Returns service metrics by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Get load balancer metrics › Responses
Created
List of frontend metrics.
List of backend metrics.
Get load balancer metrics series
Returns service metric series by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
Get load balancer metrics series › Responses
Created
Response schema for a mapping of metric series identifiers to their corresponding metrics data.
List of frontend metrics.
List of backend metrics.
Get load balancer frontend combined metrics series
Returns combined frontend metric series by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer frontend combined metrics series › Responses
Created
Response schema for a list of frontend metrics series.
start_atTimestamp marking the beginning of the metrics aggregation period.
end_atTimestamp marking the end of the metrics aggregation period.
frontendsList of frontend names or identifiers included in the aggregated data.
denied_connectionsTotal number of denied frontend connections within the time range.
denied_sessionsTotal number of denied sessions during the period.
invalid_requestsNumber of malformed or invalid HTTP requests received.
request_bytesTotal size of incoming request payloads, in bytes.
response_bytesTotal size of outgoing response payloads, in bytes.
denied_responsesNumber of HTTP responses that were denied or rejected.
http_responses_1xxCount of informational (1xx) HTTP responses.
http_responses_2xxCount of successful (2xx) HTTP responses.
http_responses_3xxCount of redirection (3xx) HTTP responses.
http_responses_4xxCount of client error (4xx) HTTP responses.
http_responses_5xxCount of server error (5xx) HTTP responses.
http_responses_otherCount of HTTP responses with codes outside the 1xx–5xx range.
sessionsTotal number of frontend sessions handled.
http_requestsTotal number of HTTP requests processed during the aggregation period.
denied_requestsTotal number of HTTP requests denied.
intercepted_requestsNumber of requests intercepted before reaching the backend.
Get load balancer frontend metrics series
Returns frontend metric series by given {service-uuid} and {frontend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
frontend-nameThe unique identifier for the frontend.
The name of the frontend.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer frontend metrics series › Responses
Created
Response schema for a list of frontend metrics series.
start_atTimestamp marking the beginning of the metrics aggregation period.
end_atTimestamp marking the end of the metrics aggregation period.
frontendsList of frontend names or identifiers included in the aggregated data.
denied_connectionsTotal number of denied frontend connections within the time range.
denied_sessionsTotal number of denied sessions during the period.
invalid_requestsNumber of malformed or invalid HTTP requests received.
request_bytesTotal size of incoming request payloads, in bytes.
response_bytesTotal size of outgoing response payloads, in bytes.
denied_responsesNumber of HTTP responses that were denied or rejected.
http_responses_1xxCount of informational (1xx) HTTP responses.
http_responses_2xxCount of successful (2xx) HTTP responses.
http_responses_3xxCount of redirection (3xx) HTTP responses.
http_responses_4xxCount of client error (4xx) HTTP responses.
http_responses_5xxCount of server error (5xx) HTTP responses.
http_responses_otherCount of HTTP responses with codes outside the 1xx–5xx range.
sessionsTotal number of frontend sessions handled.
http_requestsTotal number of HTTP requests processed during the aggregation period.
denied_requestsTotal number of HTTP requests denied.
intercepted_requestsNumber of requests intercepted before reaching the backend.
Get load balancer backend combined metrics series
Returns combined backend metric series by given {service-uuid}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer backend combined metrics series › Responses
Created
Response schema for a list of backend metrics series.
start_atTimestamp marking the start of the metrics collection period.
end_atTimestamp marking the end of the metrics collection period.
backendsList of backend identifiers included in the metrics series.
request_bytesTotal number of request bytes processed.
response_bytesTotal number of response bytes sent.
denied_responsesTotal number of denied responses.
http_responses_1xxCount of HTTP 1xx informational responses.
http_responses_2xxCount of HTTP 2xx successful responses.
http_responses_3xxCount of HTTP 3xx redirection responses.
http_responses_4xxCount of HTTP 4xx client error responses.
http_responses_5xxCount of HTTP 5xx server error responses.
http_responses_otherCount of HTTP responses outside the 1xx–5xx range.
sessionsTotal number of sessions.
downtimeTotal downtime in seconds.
failed_checks_transitionsNumber of transitions from healthy to failed health checks.
client_abortedNumber of client-aborted connections.
failed_connectionsNumber of failed connections.
invalid_responsesNumber of invalid responses.
routed_requestsNumber of routed requests.
server_abortedNumber of server-aborted connections.
server_redispatchesNumber of server redispatches.
server_connection_retriesNumber of server connection retries.
Get load balancer backend metrics series
Returns backend metric series by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer backend metrics series › Responses
Created
Response schema for a list of backend metrics series.
start_atTimestamp marking the start of the metrics collection period.
end_atTimestamp marking the end of the metrics collection period.
backendsList of backend identifiers included in the metrics series.
request_bytesTotal number of request bytes processed.
response_bytesTotal number of response bytes sent.
denied_responsesTotal number of denied responses.
http_responses_1xxCount of HTTP 1xx informational responses.
http_responses_2xxCount of HTTP 2xx successful responses.
http_responses_3xxCount of HTTP 3xx redirection responses.
http_responses_4xxCount of HTTP 4xx client error responses.
http_responses_5xxCount of HTTP 5xx server error responses.
http_responses_otherCount of HTTP responses outside the 1xx–5xx range.
sessionsTotal number of sessions.
downtimeTotal downtime in seconds.
failed_checks_transitionsNumber of transitions from healthy to failed health checks.
client_abortedNumber of client-aborted connections.
failed_connectionsNumber of failed connections.
invalid_responsesNumber of invalid responses.
routed_requestsNumber of routed requests.
server_abortedNumber of server-aborted connections.
server_redispatchesNumber of server redispatches.
server_connection_retriesNumber of server connection retries.
Get load balancer member combined metrics series
Returns combined backend members metric series by given {service-uuid} and {backend-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer member combined metrics series › Responses
Created
start_atTimestamp marking the start of the metrics collection period.
end_atTimestamp marking the end of the metrics collection period.
membersList of backend member identifiers included in the metrics series.
request_bytesTotal number of request bytes processed by all members in the series.
response_bytesTotal number of response bytes sent by all members.
denied_responsesTotal number of denied responses returned during the period.
http_responses_1xxCount of HTTP 1xx informational responses.
http_responses_2xxCount of HTTP 2xx successful responses.
http_responses_3xxCount of HTTP 3xx redirection responses.
http_responses_4xxCount of HTTP 4xx client error responses.
http_responses_5xxCount of HTTP 5xx server error responses.
http_responses_otherCount of HTTP responses outside the 1xx–5xx range.
sessionsTotal number of active or completed sessions during the metrics window.
downtimeTotal downtime duration in seconds.
failed_checks_transitionsNumber of transitions from healthy to failed health checks detected during the period.
client_abortedNumber of connections aborted by the client.
failed_connectionsNumber of backend connection attempts that failed.
invalid_responsesNumber of invalid or malformed responses detected.
routed_requestsTotal number of requests successfully routed to the backend members.
server_abortedNumber of connections aborted by the backend server.
server_redispatchesNumber of requests redispatched to another backend member after an initial failure.
server_connection_retriesNumber of backend connection retry attempts.
failed_checksTotal number of failed health checks for all members combined.
Get load balancer member metrics series
Returns backend member metric series by given {service-uuid}, {backend-name}, and {member-name}.
path Parameters
service-uuidThe unique identifier for the service.
The UUID of the service.
backend-nameThe unique identifier for the backend.
The name of the backend.
member-nameThe unique identifier for the member.
The name of the member.
query Parameters
sortSort metrics by field. Prefix with '-' for descending order.
Sort metrics by field. Prefix with '-' for descending order.
Get load balancer member metrics series › Responses
Created
start_atTimestamp marking the start of the metrics collection period.
end_atTimestamp marking the end of the metrics collection period.
membersList of backend member identifiers included in the metrics series.
request_bytesTotal number of request bytes processed by all members in the series.
response_bytesTotal number of response bytes sent by all members.
denied_responsesTotal number of denied responses returned during the period.
http_responses_1xxCount of HTTP 1xx informational responses.
http_responses_2xxCount of HTTP 2xx successful responses.
http_responses_3xxCount of HTTP 3xx redirection responses.
http_responses_4xxCount of HTTP 4xx client error responses.
http_responses_5xxCount of HTTP 5xx server error responses.
http_responses_otherCount of HTTP responses outside the 1xx–5xx range.
sessionsTotal number of active or completed sessions during the metrics window.
downtimeTotal downtime duration in seconds.
failed_checks_transitionsNumber of transitions from healthy to failed health checks detected during the period.
client_abortedNumber of connections aborted by the client.
failed_connectionsNumber of backend connection attempts that failed.
invalid_responsesNumber of invalid or malformed responses detected.
routed_requestsTotal number of requests successfully routed to the backend members.
server_abortedNumber of connections aborted by the backend server.
server_redispatchesNumber of requests redispatched to another backend member after an initial failure.
server_connection_retriesNumber of backend connection retry attempts.
failed_checksTotal number of failed health checks for all members combined.
List load balancer certificate bundles
Returns a list of available certificate bundles.
query Parameters
limitNumber of entries to receive at most.
Number of entries to receive at most.
offsetOffset for retrieved results.
Offset for retrieved results.
labelFilter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.
Filter resources by label. Can be provided multiple times for multiple labels. Format: 'key=value' for exact match or 'key' for existence check.
List load balancer certificate bundles › Responses
Created
Response schema for a list of certificate bundles.
uuidUnique identifier for the certificate bundle.
nameHuman-readable name assigned to the certificate bundle.
tls_typeThe certificate bundle type. Determines how the certificate is provisioned and managed.
operational_stateCurrent operational state of the certificate bundle.
created_atTimestamp when this certificate bundle was created.
updated_atTimestamp when this certificate bundle was last updated.
certificatePEM-encoded certificate data (base64).
intermediatesPEM-encoded intermediate certificates (base64).
hostnamesList of hostnames covered by this certificate bundle.
Problems reported during ACME challenge validation.
key_typeType of private key used for this certificate bundle.
List of load balancer services that use this certificate bundle.
not_beforeThe start date and time of certificate validity.
not_afterThe expiration date and time of certificate validity.
List of labels attached to this certificate bundle.
Create load balancer certificate bundle
Creates a new certificate bundle.
Create load balancer certificate bundle › Request Body
name^[a-zA-Z0-9_-]+$ · requiredName of the bundle
typeCertificate bundle type
hostnamesArray of hostnames
certificateCertificate
intermediatesIntermediate certificates
private_keyPrivate key
challenge_keyUnique key used for ACME DNS challenge validation when obtaining certificates dynamically.
key_typePrivate key type
Labels
Decision Table
| Variant | Matching Criteria |
|---|---|
| requires: name, type, certificate +1 more | |
| requires: name, type, hostnames +1 more | |
| requires: name, type, certificate |
typehostnameskey_typeCreate load balancer certificate bundle › Responses
Created
uuidUnique identifier for the certificate bundle.
nameHuman-readable name assigned to the certificate bundle.
tls_typeThe certificate bundle type. Determines how the certificate is provisioned and managed.
operational_stateCurrent operational state of the certificate bundle.
created_atTimestamp when this certificate bundle was created.
updated_atTimestamp when this certificate bundle was last updated.
certificatePEM-encoded certificate data (base64).
intermediatesPEM-encoded intermediate certificates (base64).
hostnamesList of hostnames covered by this certificate bundle.
Problems reported during ACME challenge validation.
key_typeType of private key used for this certificate bundle.
List of load balancer services that use this certificate bundle.
not_beforeThe start date and time of certificate validity.
not_afterThe expiration date and time of certificate validity.
List of labels attached to this certificate bundle.
Get load balancer certificate bundle
Returns certificate bundle details by given {bundle-uuid}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
Get load balancer certificate bundle › Responses
Created
uuidUnique identifier for the certificate bundle.
nameHuman-readable name assigned to the certificate bundle.
tls_typeThe certificate bundle type. Determines how the certificate is provisioned and managed.
operational_stateCurrent operational state of the certificate bundle.
created_atTimestamp when this certificate bundle was created.
updated_atTimestamp when this certificate bundle was last updated.
certificatePEM-encoded certificate data (base64).
intermediatesPEM-encoded intermediate certificates (base64).
hostnamesList of hostnames covered by this certificate bundle.
Problems reported during ACME challenge validation.
key_typeType of private key used for this certificate bundle.
List of load balancer services that use this certificate bundle.
not_beforeThe start date and time of certificate validity.
not_afterThe expiration date and time of certificate validity.
List of labels attached to this certificate bundle.
Delete load balancer certificate bundle
Deletes existing certificate bundle by given {bundle-uuid}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
Delete load balancer certificate bundle › Responses
No Content
Modify load balancer certificate bundle
Modifies existing a manual, dynamic or authority certificate bundle by given {bundle-uuid}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
Modify load balancer certificate bundle › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object |
name^[a-zA-Z0-9_-]+$Name of the bundle
certificateCertificate
intermediatesIntermediate certificates
private_keyPrivate key
Labels
Modify load balancer certificate bundle › Responses
Created
uuidUnique identifier for the certificate bundle.
nameHuman-readable name assigned to the certificate bundle.
tls_typeThe certificate bundle type. Determines how the certificate is provisioned and managed.
operational_stateCurrent operational state of the certificate bundle.
created_atTimestamp when this certificate bundle was created.
updated_atTimestamp when this certificate bundle was last updated.
certificatePEM-encoded certificate data (base64).
intermediatesPEM-encoded intermediate certificates (base64).
hostnamesList of hostnames covered by this certificate bundle.
Problems reported during ACME challenge validation.
key_typeType of private key used for this certificate bundle.
List of load balancer services that use this certificate bundle.
not_beforeThe start date and time of certificate validity.
not_afterThe expiration date and time of certificate validity.
List of labels attached to this certificate bundle.
List load balancer certificate bundle labels
Returns a list of available certificate bundle labels by given {bundle-uuid}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
List load balancer certificate bundle labels › Responses
Created
Represents a list of label key-value pairs attached to a certificate bundle within the load-balancer service, used for resource classification, billing and filtering.
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Create load balancer certificate bundle label
Creates a new label by given {bundle-uuid}.
Labels used for certificate bundles filtering.
Certificate bundle labels usage examples Below are some examples of what certain GET requests might look like.
exact match: GET /1.3/load-balancer/certificate-bundles?label=env%3Dstaging existence: GET /1.3/load-balancer/certificate-bundles?label=env multiple: GET /1.3/load-balancer/certificate-bundles?label=env&label=foo%3Dbar
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
Create load balancer certificate bundle label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredKey
value\A[\p{L}\p{N}\p{P}\p… · requiredValue
Create load balancer certificate bundle label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Get load balancer certificate bundle label
Returns label details by given {bundle-uuid} and {label-key}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
label-keyThe unique identifier for the label.
The label key parameter.
Get load balancer certificate bundle label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Delete load balancer certificate bundle label
Deletes existing label by given {bundle-uuid} and {label-key}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
label-keyThe unique identifier for the label.
The label key parameter.
Delete load balancer certificate bundle label › Responses
No Content
Modify load balancer certificate bundle label
Modifies existing label by given {bundle-uuid} and {label-key}.
path Parameters
bundle-uuidThe unique identifier for the certificate bundle.
The UUID of the certificate bundle.
label-keyThe unique identifier for the label.
The label key parameter.
Modify load balancer certificate bundle label › Request Body
key^[\x20-\x5E\x60-\x7E…Key
value\A[\p{L}\p{N}\p{P}\p…Value
Modify load balancer certificate bundle label › Responses
Created
keyLabel key used for identification and filtering.
valueThe value of the label (optional).
Get load balancer DNS challenge domain
Returns DNS challenge domain.
This can be used to validate domain ownership using the ACME challenge method. To validate your domain, you need to add CNAME record to the domain provided by this API to your DNS settings. The name/host of the CNAME record should be _acme-challenge or _acme-challenge.mysubdomain if you are setting up a subdomain called mysubdomain. The target/points to of the record needs to be set to the value returned by this API.
Get load balancer DNS challenge domain › Responses
Created
domainThe DNS challenge domain to use for ACME validation.
List load balancer plans
Returns a list of available load balancer plans.
query Parameters
limitNumber of entries to receive at most.
Number of entries to receive at most.
offsetOffset for retrieved results.
Offset for retrieved results.
List load balancer plans › Responses
Created
List of available load balancer plans, each defining the node size, performance characteristics, and associated pricing options.
nameName of the plan.
server_numberNumber of servers included in the plan.
per_server_max_sessionsMaximum number of sessions allowed per server.
Get load balancer plan
Returns load balancer plan details by given {plan-name}.
path Parameters
plan-nameThe unique identifier for the plan.
The name of the plan.
Get load balancer plan › Responses
Created
nameName of the plan.
server_numberNumber of servers included in the plan.
per_server_max_sessionsMaximum number of sessions allowed per server.