Oracle WebLogic Server APIs Domain Configuration API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server APIs Oracle WebLogic Server Deployment Application Deployments Domain Configuration API
  description: RESTful API for deploying, undeploying, redeploying, and managing applications and shared libraries on Oracle WebLogic Server. Supports uploading application archives, deploying from the server file system, managing deployment plans, and controlling application lifecycle states across servers and clusters.
  version: 14.1.1.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
servers:
- url: https://{host}:{port}/management/weblogic/latest
  description: WebLogic Server Administration Server
  variables:
    host:
      default: localhost
      description: Hostname of the WebLogic Administration Server
    port:
      default: '7001'
      description: Port of the WebLogic Administration Server
security:
- basicAuth: []
tags:
- name: Domain Configuration
  description: Read-only access to the domain-level configuration MBean tree including servers, clusters, data sources, JMS resources, and security realms.
paths:
  /domainConfig:
    get:
      operationId: getDomainConfigRoot
      summary: Oracle WebLogic Server APIs Get domain configuration tree root
      description: Returns the root resource of the read-only domain configuration tree, providing links to all configuration resources in the domain.
      tags:
      - Domain Configuration
      responses:
        '200':
          description: Domain configuration root resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /domainConfig/servers:
    get:
      operationId: getDomainConfigServers
      summary: Oracle WebLogic Server APIs List all server configurations (read-only)
      description: Returns all server configurations in the domain (read-only view).
      tags:
      - Domain Configuration
      responses:
        '200':
          description: List of server configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServerConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /domainConfig/servers/{serverName}:
    get:
      operationId: getDomainConfigServer
      summary: Oracle WebLogic Server APIs Get a server configuration (read-only)
      description: Returns the configuration of a specific server (read-only view).
      tags:
      - Domain Configuration
      parameters:
      - $ref: '#/components/parameters/serverName'
      responses:
        '200':
          description: Server configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /domainConfig/clusters:
    get:
      operationId: getDomainConfigClusters
      summary: Oracle WebLogic Server APIs List all cluster configurations (read-only)
      description: Returns all cluster configurations in the domain (read-only view).
      tags:
      - Domain Configuration
      responses:
        '200':
          description: List of cluster configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ClusterConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /domainConfig/securityConfiguration:
    get:
      operationId: getDomainSecurityConfig
      summary: Oracle WebLogic Server APIs Get domain security configuration
      description: Returns the security configuration of the domain including realms.
      tags:
      - Domain Configuration
      responses:
        '200':
          description: Security configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ServerConfiguration:
      type: object
      properties:
        name:
          type: string
          description: Server name
        listenAddress:
          type: string
          description: Listen address for the server
        listenPort:
          type: integer
          description: Listen port for the server
          default: 7001
        SSLListenPort:
          type: integer
          description: SSL listen port
        cluster:
          type: string
          description: Cluster this server belongs to
        machine:
          type: string
          description: Machine this server is assigned to
        listenPortEnabled:
          type: boolean
          description: Whether the plain-text listen port is enabled
        clientCertProxyEnabled:
          type: boolean
          description: Whether client cert proxy is enabled
        startupMode:
          type: string
          description: Server startup mode
          enum:
          - RUNNING
          - STANDBY
          - ADMIN
        autoRestart:
          type: boolean
          description: Whether the server automatically restarts on failure
        restartMax:
          type: integer
          description: Maximum number of restart attempts
        javaCompiler:
          type: string
          description: Java compiler to use for JSP compilation
        stagingMode:
          type: string
          description: Application staging mode
          enum:
          - stage
          - nostage
          - external_stage
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
      required:
      - name
    Error:
      type: object
      properties:
        type:
          type: string
          description: Error type URI
        title:
          type: string
          description: Short error title
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Detailed error message
        o:errorPath:
          type: string
          description: Path to the field that caused the error
    SecurityConfiguration:
      type: object
      properties:
        name:
          type: string
        realms:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              authenticationProviders:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    type:
                      type: string
        crossDomainSecurityEnabled:
          type: boolean
        webAppFilesCaseInsensitive:
          type: string
          enum:
          - os
          - 'true'
          - 'false'
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
          description: Link URI
        title:
          type: string
          description: Link title
    ClusterConfiguration:
      type: object
      properties:
        name:
          type: string
          description: Cluster name
        clusterMessagingMode:
          type: string
          description: Messaging mode for the cluster
          enum:
          - unicast
          - multicast
        clusterBroadcastChannel:
          type: string
          description: Multicast channel for cluster communication
        clusterAddress:
          type: string
          description: Comma-separated list of address:port pairs for cluster members
        defaultLoadAlgorithm:
          type: string
          description: Load balancing algorithm
          enum:
          - round-robin
          - weight-based
          - round-robin-affinity
          - weight-based-affinity
          - random
        weblogicPluginEnabled:
          type: boolean
          description: Whether the WebLogic plugin is enabled
        frontendHost:
          type: string
          description: Frontend host for the cluster
        frontendHTTPPort:
          type: integer
          description: Frontend HTTP port
        frontendHTTPSPort:
          type: integer
          description: Frontend HTTPS port
        numberOfServersInClusterAddress:
          type: integer
          description: Number of servers in the cluster address
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
      required:
      - name
    DomainConfiguration:
      type: object
      properties:
        name:
          type: string
          description: Domain name
        adminServerName:
          type: string
          description: Name of the administration server
        domainVersion:
          type: string
          description: WebLogic Server domain version
        productionModeEnabled:
          type: boolean
          description: Whether the domain is in production mode
        configurationVersion:
          type: string
          description: Configuration version string
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
  responses:
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    serverName:
      name: serverName
      in: path
      required: true
      description: The name of the WebLogic Server instance
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: WebLogic Server administrator credentials
externalDocs:
  description: Deploying Applications to Oracle WebLogic Server
  url: https://docs.oracle.com/en/middleware/standalone/weblogic-server/14.1.1.0/develop-and-deploy.html