Oracle Load Balancer API
The loadBalancer API from Oracle — 34 operation(s) for loadbalancer.
Oracle Load Balancer API is one of 378 APIs that Oracle 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 an API reference.
This API exposes 61 operations across 34 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 20170115.
Requests are made against a single base URL, /20170115.
61 operations
34 paths
67 schemas
10 DELETE28 GET11 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 61
Across 34 paths, the API surfaces 61 operations — 10 DELETE, 28 GET, 11 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
loadBalancer 61
GET
/loadBalancerHealths
ListLoadBalancerHealths
GET
/loadBalancerPolicies
ListPolicies
GET
/loadBalancerProtocols
ListProtocols
GET
/loadBalancerShapes
ListShapes
GET
/loadBalancerWorkRequests/{workRequestId}
GetWorkRequest
GET
/loadBalancers
ListLoadBalancers
POST
/loadBalancers
CreateLoadBalancer
DELETE
/loadBalancers/{loadBalancerId}
DeleteLoadBalancer
GET
/loadBalancers/{loadBalancerId}
GetLoadBalancer
PUT
/loadBalancers/{loadBalancerId}
UpdateLoadBalancer
GET
/loadBalancers/{loadBalancerId}/backendSets
ListBackendSets
POST
/loadBalancers/{loadBalancerId}/backendSets
CreateBackendSet
DELETE
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}
DeleteBackendSet
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}
GetBackendSet
PUT
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}
UpdateBackendSet
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends
ListBackends
POST
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends
CreateBackend
DELETE
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}
DeleteBackend
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}
GetBackend
PUT
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}
UpdateBackend
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/backends/{backendName}/health
BackendHealth
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/health
BackendSetHealth
GET
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker
GetHealthChecker
PUT
/loadBalancers/{loadBalancerId}/backendSets/{backendSetName}/healthChecker
UpdateHealthChecker
GET
/loadBalancers/{loadBalancerId}/certificates
ListCertificates
POST
/loadBalancers/{loadBalancerId}/certificates
CreateCertificate
DELETE
/loadBalancers/{loadBalancerId}/certificates/{certificateName}
DeleteCertificate
POST
/loadBalancers/{loadBalancerId}/changeCompartment
ChangeLoadBalancerCompartment
GET
/loadBalancers/{loadBalancerId}/health
LoadBalancerHealth
GET
/loadBalancers/{loadBalancerId}/hostnames
ListHostnames
POST
/loadBalancers/{loadBalancerId}/hostnames
CreateHostname
DELETE
/loadBalancers/{loadBalancerId}/hostnames/{name}
DeleteHostname
GET
/loadBalancers/{loadBalancerId}/hostnames/{name}
GetHostname
PUT
/loadBalancers/{loadBalancerId}/hostnames/{name}
UpdateHostname
POST
/loadBalancers/{loadBalancerId}/listeners
CreateListener
DELETE
/loadBalancers/{loadBalancerId}/listeners/{listenerName}
DeleteListener
PUT
/loadBalancers/{loadBalancerId}/listeners/{listenerName}
UpdateListener
GET
/loadBalancers/{loadBalancerId}/listeners/{listenerName}/rules
ListListenerRules
PUT
/loadBalancers/{loadBalancerId}/networkSecurityGroups
UpdateNetworkSecurityGroups
GET
/loadBalancers/{loadBalancerId}/pathRouteSetsdeprecated
ListPathRouteSets
POST
/loadBalancers/{loadBalancerId}/pathRouteSetsdeprecated
CreatePathRouteSet
DELETE
/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}deprecated
DeletePathRouteSet
GET
/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}deprecated
GetPathRouteSet
PUT
/loadBalancers/{loadBalancerId}/pathRouteSets/{pathRouteSetName}deprecated
UpdatePathRouteSet
GET
/loadBalancers/{loadBalancerId}/routingPolicies
ListRoutingPolicies
POST
/loadBalancers/{loadBalancerId}/routingPolicies
CreateRoutingPolicy
DELETE
/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}
DeleteRoutingPolicy
GET
/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}
GetRoutingPolicy
PUT
/loadBalancers/{loadBalancerId}/routingPolicies/{routingPolicyName}
UpdateRoutingPolicy
GET
/loadBalancers/{loadBalancerId}/ruleSets
ListRuleSets
POST
/loadBalancers/{loadBalancerId}/ruleSets
CreateRuleSet
DELETE
/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}
DeleteRuleSet
GET
/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}
GetRuleSet
PUT
/loadBalancers/{loadBalancerId}/ruleSets/{ruleSetName}
UpdateRuleSet
GET
/loadBalancers/{loadBalancerId}/sslCipherSuites
ListSSLCipherSuites
POST
/loadBalancers/{loadBalancerId}/sslCipherSuites
CreateSSLCipherSuite
DELETE
/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}
DeleteSSLCipherSuite
GET
/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}
GetSSLCipherSuite
PUT
/loadBalancers/{loadBalancerId}/sslCipherSuites/{name}
UpdateSSLCipherSuite
PUT
/loadBalancers/{loadBalancerId}/updateShape
UpdateLoadBalancerShape
GET
/loadBalancers/{loadBalancerId}/workRequests
ListWorkRequests
Schemas 67
The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are LoadBalancer (27 properties), CreateLoadBalancerDetails (23 properties), CreateListenerDetails (10 properties), Listener (10 properties). Each schema is shown below with its type and property counts.
SessionPersistenceConfigurationDetails
object
The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness). Session persistence enabl…
2 properties
1 required
UpdateListenerDetails
object
The configuration details for updating a listener.
9 properties
3 required
CertificateDetails
object
The configuration details for a certificate bundle. For more information on SSL certficate configuration, see [Managing SSL Certificates](/Content/Balance/Task…
5 properties
1 required
UpdateHostnameDetails
object
The configuration details for updating a virtual hostname. For more information on virtual hostnames, see [Managing Request Routing](/Content/Balance/Tasks/man…
1 property
SSLConfigurationDetails
object
The load balancer's SSL handling configuration details. Warning: Oracle recommends that you avoid using any confidential information when you supply string val…
8 properties
Certificate
object
The configuration details of a certificate bundle. For more information on SSL certficate configuration, see [Managing SSL Certificates](/Content/Balance/Tasks…
3 properties
3 required
HealthCheckResult
object
Information about a single backend server health check result reported by a load balancer.
4 properties
4 required
CreateBackendSetDetails
object
The configuration details for creating a backend set in a load balancer. For more information on backend set configuration, see [Managing Backend Sets](/Conten…
7 properties
3 required
CreateHostnameDetails
object
The details of the hostname resource to add to a load balancer. Warning: Oracle recommends that you avoid using any confidential information when you supply st…
2 properties
2 required
CreateSSLCipherSuiteDetails
object
The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket La…
2 properties
2 required
LoadBalancerPolicy
object
A policy that determines how traffic is distributed among backend servers. For more information on load balancing policies, see [How Load Balancing Policies Wo…
1 property
1 required
WorkRequestError
object
An object returned in the event of a work request error.
2 properties
2 required
UpdateRuleSetDetails
object
An updated set of rules that overwrites the existing set of rules.
1 property
1 required
CreatePathRouteSetDetails
object
A named set of path route rules to add to the load balancer. Warning: Oracle recommends that you avoid using any confidential information when you supply strin…
2 properties
2 required
BackendHealth
object
The health status of the specified backend server as reported by the primary and standby load balancers.
2 properties
2 required
SSLCipherSuiteDetails
object
The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket La…
2 properties
2 required
UpdateLoadBalancerDetails
object
Configuration details to update a load balancer. Warning: Oracle recommends that you avoid using any confidential information when you supply string values usi…
8 properties
PathMatchType
object
The type of matching to apply to incoming URIs.
1 property
1 required
WorkRequest
object
Many of the API requests you use to create and configure load balancing do not take effect immediately. In these cases, the request spawns an asynchronous work…
9 properties
7 required
SSLConfiguration
object
A listener's SSL handling configuration. To use SSL, a listener must be associated with a [certificate bundle](/en/loadbalancer/20170115/Certificate/). Warning…
8 properties
2 required
LoadBalancerHealthSummary
object
A health status summary for the specified load balancer.
2 properties
2 required
BackendSet
object
The configuration of a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Tasks/managin…
7 properties
4 required
BackendSetHealth
object
The health status details for a backend set. This object does not explicitly enumerate backend servers with a status of OK. However, they are included in the t…
5 properties
5 required
BackendSetDetails
object
The configuration details for a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Balance/Task…
6 properties
2 required
HostnameDetails
object
The details of a hostname resource associated with a load balancer.
2 properties
2 required
UpdateBackendSetDetails
object
The configuration details for updating a load balancer backend set. For more information on backend set configuration, see [Managing Backend Sets](/Content/Bal…
6 properties
3 required
LoadBalancerShape
object
A shape is a template that determines the total pre-provisioned bandwidth (ingress plus egress) for the load balancer. Note that the pre-provisioned maximum ca…
1 property
1 required
Hostname
object
A hostname resource associated with a load balancer for use by one or more listeners. Warning: Oracle recommends that you avoid using any confidential informat…
2 properties
2 required
UpdateLoadBalancerShapeDetails
object
2 properties
1 required
PathRouteSetDetails
object
A set of path route rules.
1 property
1 required
HealthChecker
object
The health check policy configuration. For more information, see [Editing Health Check Policies](/Content/Balance/Tasks/editinghealthcheck.htm).
9 properties
4 required
CreateRuleSetDetails
object
A named set of rules to add to the load balancer.
2 properties
2 required
LoadBalancerProtocol
object
A protocol that defines the type of traffic accepted by a listener.
1 property
1 required
Backend
object
The configuration of a backend server that is a member of a load balancer backend set. For more information, see [Managing Backend Servers](/Content/Balance/Ta…
8 properties
7 required
RuleSetDetails
object
The rules that compose a rule set.
1 property
1 required
ConnectionConfiguration
object
Configuration details for the connection between the client and backend servers.
3 properties
1 required
LoadBalancer
object
The properties that define a load balancer. For more information, see [Managing a Load Balancer](/Content/Balance/Tasks/managingloadbalancer.htm). To use any o…
27 properties
6 required
UpdateBackendDetails
object
The configuration details for updating a backend server.
5 properties
4 required
Action
object
An entity that represents an action to apply for a routing rule.
1 property
1 required
SSLCipherSuite
object
The configuration details of an SSL cipher suite. The algorithms that compose a cipher suite help you secure Transport Layer Security (TLS) or Secure Socket La…
2 properties
2 required
RoutingPolicy
object
A named ordered list of routing rules that is applied to a listener. Warning: Oracle recommends that you avoid using any confidential information when you supp…
3 properties
3 required
UpdatePathRouteSetDetails
object
An updated set of path route rules that overwrites the existing set of rules.
1 property
1 required
HealthCheckerDetails
object
The health check policy's configuration details.
9 properties
1 required
CreateBackendDetails
object
The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see [Managing Backend Servers](…
7 properties
2 required
UpdateNetworkSecurityGroupsDetails
object
An object representing an updated list of network security groups (NSGs) that overwrites the existing list of NSGs. If the load balancer has no NSGs configured…
1 property
ListenerDetails
object
The listener's configuration details.
9 properties
3 required
RoutingRule
object
A routing rule examines an incoming request, routing matching requests to the specified backend set. Routing rules apply only to HTTP and HTTPS requests. They…
3 properties
3 required
ChangeLoadBalancerCompartmentDetails
object
The configuration details for moving a load balancer to a different compartment. Warning: Oracle recommends that you avoid using any confidential information w…
1 property
1 required
CreateRoutingPolicyDetails
object
An ordered list of routing rules. Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
3 properties
3 required
LoadBalancerHealth
object
The health status details for the specified load balancer. This object does not explicitly enumerate backend sets with a status of OK. However, they are includ…
5 properties
5 required
Error
object
2 properties
2 required
BackendDetails
object
The load balancing configuration details of a backend server.
7 properties
2 required
PathRouteSet
object
A named set of path route rules. For more information, see [Managing Request Routing](/Content/Balance/Tasks/managingrequest.htm). Warning: Oracle recommends t…
2 properties
2 required
UpdateHealthCheckerDetails
object
The health checker's configuration details.
9 properties
7 required
ShapeDetails
object
The configuration details to update load balancer to a different shape.
2 properties
2 required
ListenerRuleSummary
object
The attributes of a rule associated with the specified listener, and the name of the rule set that the rule belongs to.
2 properties
IpAddress
object
A load balancer IP address.
3 properties
1 required
ReservedIP
object
1 property
UpdateRoutingPolicyDetails
object
An updated list of routing rules that overwrites the existing list of routing rules.
2 properties
1 required
CreateCertificateDetails
object
The configuration details for adding a certificate bundle to a listener. For more information on SSL certficate configuration, see [Managing SSL Certificates](…
5 properties
1 required
CreateLoadBalancerDetails
object
The configuration details for creating a load balancer. Warning: Oracle recommends that you avoid using any confidential information when you supply string val…
23 properties
4 required
Listener
object
The listener's configuration. For more information on backend set configuration, see [Managing Load Balancer Listeners](/Content/Balance/Tasks/managinglistener…
10 properties
4 required
CreateListenerDetails
object
The configuration details for adding a listener to a backend set. For more information on listener configuration, see [Managing Load Balancer Listeners](/Conte…
10 properties
4 required
UpdateSSLCipherSuiteDetails
object
The configuration details for updating an SSL cipher suite. Warning: Oracle recommends that you avoid using any confidential information when you supply string…
1 property
1 required
Rule
object
An object that represents an action to apply to a listener.
1 property
1 required
RuleSet
object
A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener, such as adding, altering, or removing HT…
2 properties
2 required
PathRoute
object
A "path route rule" to evaluate an incoming URI path, and then route a matching request to the specified backend set. Path route rules apply only to HTTP and H…
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#Load Balancer
Where this information came from
This is an independent, third-party profile of Oracle 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.