Oracle WebLogic Server Clusters API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Deployment Application Deployment Clusters API
  description: RESTful API for deploying, undeploying, and managing application and library deployments on Oracle WebLogic Server. Supports deploying enterprise applications (EAR, WAR), shared libraries, and managing deployment lifecycle including start, stop, and redeploy operations. All deployment configuration changes require an active edit session with startEdit/activate workflow. Runtime deployment lifecycle operations (start/stop) are available through the domainRuntime tree.
  version: 12.2.1.3.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com/
  license:
    name: Oracle Standard License
    url: https://www.oracle.com/downloads/licenses/standard-license.html
servers:
- url: http://localhost:7001/management/weblogic/latest
  description: WebLogic Administration Server (default)
- url: http://{host}:{port}/management/weblogic/{version}
  description: WebLogic Administration Server (configurable)
  variables:
    host:
      default: localhost
    port:
      default: '7001'
    version:
      default: latest
security:
- basicAuth: []
tags:
- name: Clusters
  description: Manage WebLogic Server clusters and dynamic servers
paths:
  /edit/clusters:
    get:
      operationId: listClusters
      summary: Oracle WebLogic Server List all clusters
      description: Returns a collection of all cluster configurations in the domain.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of clusters
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Cluster'
    post:
      operationId: createCluster
      summary: Oracle WebLogic Server Create a new cluster
      description: Creates a new cluster configuration. Requires an active edit session.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterCreateRequest'
      responses:
        '201':
          description: Cluster created successfully
          headers:
            Location:
              schema:
                type: string
                format: uri
  /edit/clusterCreateForm:
    get:
      operationId: getClusterCreateForm
      summary: Oracle WebLogic Server Get cluster creation form with defaults
      tags:
      - Clusters
      responses:
        '200':
          description: Cluster create form with default values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterCreateRequest'
  /edit/clusters/{clusterName}:
    get:
      operationId: getCluster
      summary: Oracle WebLogic Server Get a specific cluster configuration
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/ClusterName'
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Cluster configuration details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: updateCluster
      summary: Oracle WebLogic Server Update a cluster configuration
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/ClusterName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterUpdateRequest'
      responses:
        '200':
          description: Cluster updated
    delete:
      operationId: deleteCluster
      summary: Oracle WebLogic Server Delete a cluster
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/ClusterName'
      - $ref: '#/components/parameters/XRequestedBy'
      responses:
        '204':
          description: Cluster deleted
  /edit/clusters/{clusterName}/dynamicServers:
    get:
      operationId: getDynamicServers
      summary: Oracle WebLogic Server Get dynamic server configuration for a cluster
      description: Returns the dynamic server configuration for the specified cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/ClusterName'
      responses:
        '200':
          description: Dynamic servers configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicServers'
    post:
      operationId: updateDynamicServers
      summary: Oracle WebLogic Server Configure dynamic servers for a cluster
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/ClusterName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DynamicServers'
      responses:
        '200':
          description: Dynamic servers configuration updated
components:
  parameters:
    Links:
      name: links
      in: query
      description: Comma-separated list of link relations to include (e.g., self, parent, canonical). Use 'none' to exclude all links.
      schema:
        type: string
      example: none
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header required for POST and DELETE requests
      schema:
        type: string
        example: MyClient
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include in the response
      schema:
        type: string
      example: name,listenPort
    ClusterName:
      name: clusterName
      in: path
      required: true
      description: Name of the cluster
      schema:
        type: string
  responses:
    NotFound:
      description: Requested resource does not exist
  schemas:
    ClusterCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Cluster name
        clusterMessagingMode:
          type: string
          enum:
          - unicast
          - multicast
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
          description: URL of the linked resource
        title:
          type: string
          description: Human-readable title for the link
    ClusterUpdateRequest:
      type: object
      properties:
        clusterMessagingMode:
          type: string
          enum:
          - unicast
          - multicast
        defaultLoadAlgorithm:
          type: string
          enum:
          - round-robin
          - weight-based
          - random
        weblogicPluginEnabled:
          type: boolean
    DynamicServers:
      type: object
      properties:
        serverTemplate:
          type: array
          items:
            type: string
          description: Server template reference as identity path
        dynamicClusterSize:
          type: integer
          description: Number of dynamic server instances
        maxDynamicClusterSize:
          type: integer
          description: Maximum number of dynamic server instances
        serverNamePrefix:
          type: string
          description: Prefix for dynamically created server names
        calculateListenPorts:
          type: boolean
          description: Whether to auto-calculate listen ports
    Cluster:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Cluster name
        clusterMessagingMode:
          type: string
          description: Messaging mode for the cluster
          enum:
          - unicast
          - multicast
        clusterBroadcastChannel:
          type: string
        defaultLoadAlgorithm:
          type: string
          enum:
          - round-robin
          - weight-based
          - random
          - round-robin-affinity
          - weight-based-affinity
        weblogicPluginEnabled:
          type: boolean
        frontendHost:
          type: string
        frontendHTTPPort:
          type: integer
        frontendHTTPSPort:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication. Deployer role required for deployment operations, Operator role for lifecycle operations.
externalDocs:
  description: WebLogic Server Deployment Documentation
  url: https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm