Oracle Load Balancer API

The loadBalancer API from Oracle — 34 operation(s) for loadbalancer.

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

OpenAPI Specification

oracle-loadbalancer-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'API for the Load Balancing service. Use this API to manage load balancers, backend sets, and related items. For more

    information, see [Overview of Load Balancing](/iaas/Content/Balance/Concepts/balanceoverview.htm).

    '
  title: Load Balancing Load Balancer API
  version: '20170115'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/b6419140fb4ac827445b4aac56633924a590bd456e678229e1c16c1afbcb7227.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Load Balancing API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/b6419140fb4ac827445b4aac56633924a590bd456e678229e1c16c1afbcb7227.yaml
    what: the harvested document for Load Balancing API
servers:
- url: /20170115
tags:
- name: loadBalancer
paths:
  /loadBalancerHealths:
    get:
      description: Lists the summary health statuses for all load balancers in the specified compartment.
      operationId: ListLoadBalancerHealths
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `50`

          '
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
          default: 10
      - description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `3`

          '
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to return health status information for.
        in: query
        name: compartmentId
        required: true
        schema:
          type: string
      responses:
        200:
          description: The health status information was retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadBalancerHealthSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListLoadBalancerHealths
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancerHealths

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /loadBalancerPolicies:
    get:
      description: Lists the available load balancer policies.
      operationId: ListPolicies
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer policies to list.
        in: query
        name: compartmentId
        required: true
        schema:
          type: string
      - description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `50`

          '
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
          default: 16
      - description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `3`

          '
        in: query
        name: page
        required: false
        schema:
          type: string
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadBalancerPolicy'
                type: array
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListPolicies
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancerPolicies?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /loadBalancerProtocols:
    get:
      description: Lists all supported traffic protocols.
      operationId: ListProtocols
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer protocols to list.
        in: query
        name: compartmentId
        required: true
        schema:
          type: string
      - description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `50`

          '
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
          default: 16
      - description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `3`

          '
        in: query
        name: page
        required: false
        schema:
          type: string
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadBalancerProtocol'
                type: array
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListProtocols
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancerProtocols?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /loadBalancerShapes:
    get:
      description: Lists the valid load balancer shapes.
      operationId: ListShapes
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer shapes to list.
        in: query
        name: compartmentId
        required: true
        schema:
          type: string
      - description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `50`

          '
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
          default: 16
      - description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `3`

          '
        in: query
        name: page
        required: false
        schema:
          type: string
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadBalancerShape'
                type: array
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListShapes
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancerShapes?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /loadBalancerWorkRequests/{workRequestId}:
    get:
      description: Gets the details of a work request.
      operationId: GetWorkRequest
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request to retrieve.
        in: path
        name: workRequestId
        required: true
        schema:
          type: string
      responses:
        200:
          description: The work request is being retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetWorkRequest
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancerWorkRequests/<var>&lt;work_request_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /loadBalancers:
    get:
      description: Lists all load balancers in the specified compartment.
      operationId: ListLoadBalancers
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `50`

          '
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
          default: 10
      - description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call.

          For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).


          Example: `3`

          '
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancers to list.
        in: query
        name: compartmentId
        required: true
        schema:
          type: string
      - description: 'The level of detail to return for each result. Can be `full` or `simple`.


          Example: `full`

          '
        in: query
        name: detail
        required: false
        schema:
          type: string
          default: full
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/FilterByDisplayNameQueryParam'
      - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/LoadBalancer'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListLoadBalancers
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancers?compartmentId=<var>&lt;compartment_OCID&gt;</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    post:
      description: 'Creates a new load balancer in the specified compartment. For general information about load balancers,

        see [Overview of the Load Balancing Service](/Content/Balance/Concepts/balanceoverview.htm).


        For the purposes of access control, you must provide the OCID of the compartment where you want

        the load balancer to reside. Notice that the load balancer doesn''t have to be in the same compartment as the VCN

        or backend set. If you''re not sure which compartment to use, put the load balancer in the same compartment as the VCN.

        For information about access control and compartments, see

        [Overview of the IAM Service](/Content/Identity/Concepts/overview.htm).


        You must specify a display name for the load balancer. It does not have to be unique, and you can change it.


        For information about Availability Domains, see

        [Regions and Availability Domains](/Content/General/Concepts/regions.htm).

        To get a list of Availability Domains, use the `ListAvailabilityDomains` operation

        in the Identity and Access Management Service API.


        All Oracle Cloud Infrastructure resources, including load balancers, get an Oracle-assigned,

        unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID

        in the response. You can also retrieve a resource''s OCID by using a List API operation on that resource type,

        or by viewing the resource in the Console. Fore more information, see

        [Resource Identifiers](/Content/General/Concepts/identifiers.htm).


        After you send your request, the new object''s state will temporarily be PROVISIONING. Before using the

        object, first make sure its state has changed to RUNNING.


        When you create a load balancer, the system assigns an IP address.

        To get the IP address, use the [GetLoadBalancer](#/en/loadbalancer/20170115/LoadBalancer/GetLoadBalancer) operation.

        '
      operationId: CreateLoadBalancer
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        204:
          description: The request was accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: CreateLoadBalancer
      tags:
      - loadBalancer
      x-example: "POST /20170115/loadBalancers\nHost: iaas.us-phoenix-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example_load_balancer\",\n  \"shapeName\": \"flexible\",\n  \"shapeDetails\": {\n    \"minimumBandwidthInMbps\": 10,\n    \"maximumBandwidthInMbps\": 100\n  },\n  \"isPrivate\": true,\n  \"ipMode\": \"IPV4\",\n  isDeleteProtectionEnabled: true,\n\n  \"listeners\": {\n    \"exampleListener\": {\n      \"defaultBackendSetName\": \"example_backend_set\",\n      \"port\": 80,\n      \"protocol\": \"HTTP\",\n      \"pathRouteSetName\": \"example_path_route_set\",\n      \"sslConfiguration\": {\n        \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n        \"cipherSuiteName\" : \"example_cipher_suite\",\n        \"serverOrderPreference\" : \"ENABLED\",\n        \"certificateName\": \"example_certificate_bundle\",\n        \"verifyPeerCertificate\": true,\n        \"verifyDepth\": 3\n      },\n      \"connectionConfiguration\": {\n        \"idleTimeout\": 1200\n      }\n    }\n  },\n  \"hostnames\": {\n    \"example_hostname_001\": {\n      \"name\": \"example_hostname_001\",\n      \"hostname\": \"app.example.com\"\n    },\n    \"example_hostname_002\": {\n      \"name\": \"example_hostname_002\",\n      \"hostname\": \"app.example.*\"\n    }\n  },\n  \"backendSets\": {\n    \"example_backend_set\": {\n      \"policy\": \"LEAST_CONNECTIONS\",\n      \"backends\": [\n        {\n          \"ipAddress\": \"10.0.0.3\",\n          \"port\": 8080,\n          \"weight\": 3,\n          \"backup\": false,\n          \"drain\": false,\n          \"offline\": false\n        },\n        {\n          \"ipAddress\": \"10.0.0.4\",\n          \"port\": 8080,\n          \"weight\": 1,\n          \"backup\": false,\n          \"drain\": false,\n          \"offline\": false\n        }\n      ],\n      \"healthChecker\": {\n        \"protocol\": \"HTTP\",\n        \"isForcePlainText\": false,\n        \"urlPath\": \"/healthcheck\",\n        \"port\": 8080,\n        \"returnCode\": 200,\n        \"retries\": 3,\n        \"timeoutInMillis\": 3000,\n        \"intervalInMillis\": 10000,\n        \"responseBodyRegex\": \"^((?!false).|\\s)*$\"\n      },\n      \"sslConfiguration\": {\n        \"protocols\": [\"TLSv1.1\", \"TLSv1.2\"],\n        \"cipherSuiteName\" : \"example_cipher_suite\",\n        \"serverOrderPreference\" : \"ENABLED\",\n        \"certificateName\": \"example_certificate_bundle\",\n        \"verifyPeerCertificate\": true,\n        \"verifyDepth\": 3\n      },\n      \"sessionPersistenceConfiguration\": {\n        \"cookieName\": \"example_cookie\",\n        \"disableFallback\": false\n      }\n    },\n  },\n  \"certificates\": {\n    \"example_certificate_bundle\": {\n      \"passphrase\": \"<var>&lt;passphrase&gt</var>\",\n      \"privateKey\": \"<var>&lt;private_key&gt</var>\",\n      \"publicCertificate\": \"<var>&lt;public_certificate&gt</var>\",\n      \"caCertificate\": \"<var>&lt;ca_certificate&gt</var>\",\n      \"certificateName\": \"example_certificate_bundle\"\n    }\n  },\n  \"sslCipherSuites\": {\n    \"example_cipher_suite\": {\n      \"ciphers\": [\n           \"ECDHE-ECDSA-AES128-GCM-SHA256\",\n           \"ECDHE-ECDSA-AES128-SHA256\",\n           \"ECDHE-RSA-AES128-GCM-SHA256\"\n      ],\n      \"name\": \"example_cipher_suite\"\n    }\n  },\n  \"pathRouteSets\": {\n    \"example_path_route_set\": {\n      \"pathRoutes\": [\n        {\n          \"path\": \"/example/video/123\",\n          \"pathMatchType\": {\n            \"matchType\": \"EXACT_MATCH\"\n          },\n          \"backendSetName\": \"example_backend_set\"\n        }\n      ]\n    }\n  },\n  \"ruleSets\": {\n      \"example_rule_set\": {\n        \"items\": [\n          {\n            \"action\": \"ADD_REQUEST_HEADER\",\n            \"header\": \"example_header_name\",\n            \"value\": \"example_value\"\n          },\n          {\n            \"action\": \"EXTEND_HTTP_REQUEST_HEADER_VALUE\",\n            \"header\": \"example_header_name2\",\n            \"prefix\": \"example_prefix_value\",\n            \"suffix\": \"example_suffix_value\"\n          }\n        ]\n      }\n    }\n  },\n  \"subnetIds\": [\n    \"ocid1.subnet.oc1.phx.<var>&lt;unique_ID&gt;</var>\"\n  ]\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoadBalancerDetails'
        description: The configuration details for creating a load balancer.
        required: true
  /loadBalancers/{loadBalancerId}:
    delete:
      description: Stops a load balancer and removes it from service.
      operationId: DeleteLoadBalancer
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to delete.
        in: path
        name: loadBalancerId
        required: true
        schema:
          type: string
      responses:
        204:
          description: The request to delete the load balancer was accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: DeleteLoadBalancer
      tags:
      - loadBalancer
      x-example: 'DELETE /20170115/loadBalancers/<var>&lt;load_balancer_OCID&gt</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    get:
      description: Gets the specified load balancer's configuration information.
      operationId: GetLoadBalancer
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to retrieve.
        in: path
        name: loadBalancerId
        required: true
        schema:
          type: string
      responses:
        200:
          description: The configuration information is being retrieved.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoadBalancer'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetLoadBalancer
      tags:
      - loadBalancer
      x-example: 'GET /20170115/loadBalancers/<var>&lt;load_balancer_OCID&gt</var>

        Host: iaas.us-phoenix-1.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
    put:
      description: Updates a load balancer's configuration.
      operationId: UpdateLoadBalancer
      parameters:
      - description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

          particular request, please provide the request ID.

          '
        in: header
        name: opc-request-id
        required: false
        schema:
          type: string
          default: ''
      - $ref: '#/components/parameters/RetryTokenHeader'
      - description: The [OCID](/Content/General/Concepts/identifiers.htm) of the load balancer to update.
        in: path
        name: loadBalancerId
        required: true
        schema:
          type: string
      responses:
        204:
          description: The request was accepted for processing.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: The [OCID](/Content/General/Concepts/identifiers.htm) of the work request.
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: UpdateLoadBalancer


# --- truncated at 32 KB (367 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-loadbalancer-api-openapi.yml