Oracle WebLogic Server APIs Server Runtime API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server APIs Oracle WebLogic Server Deployment Application Deployments Server Runtime 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: Server Runtime
  description: Access to server-level runtime MBeans providing monitoring data for individual server instances including thread pools, JDBC, JMS, and application runtimes.
paths:
  /serverRuntime:
    get:
      operationId: getServerRuntimeRoot
      summary: Oracle WebLogic Server APIs Get server runtime tree root
      description: Returns the root resource of the server runtime MBean tree for the server handling the request.
      tags:
      - Server Runtime
      responses:
        '200':
          description: Server runtime root resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/JVMRuntime:
    get:
      operationId: getJVMRuntime
      summary: Oracle WebLogic Server APIs Get JVM runtime information
      description: Returns JVM runtime information including heap usage, uptime, and Java version for the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: JVM runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JVMRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/threadPoolRuntime:
    get:
      operationId: getThreadPoolRuntime
      summary: Oracle WebLogic Server APIs Get thread pool runtime information
      description: Returns thread pool runtime information including active threads, queue length, and throughput metrics for the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: Thread pool runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThreadPoolRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/JDBCServiceRuntime:
    get:
      operationId: getJDBCServiceRuntime
      summary: Oracle WebLogic Server APIs Get JDBC service runtime information
      description: Returns JDBC service runtime information including data source runtimes and connection pool metrics.
      tags:
      - Server Runtime
      responses:
        '200':
          description: JDBC service runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JDBCServiceRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/JDBCServiceRuntime/JDBCDataSourceRuntimeMBeans:
    get:
      operationId: getJDBCDataSourceRuntimes
      summary: Oracle WebLogic Server APIs List all JDBC data source runtimes
      description: Returns runtime information for all JDBC data sources on the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: List of JDBC data source runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/JDBCDataSourceRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/JDBCServiceRuntime/JDBCDataSourceRuntimeMBeans/{dataSourceName}:
    get:
      operationId: getJDBCDataSourceRuntime
      summary: Oracle WebLogic Server APIs Get a JDBC data source runtime
      description: Returns runtime information for a specific JDBC data source.
      tags:
      - Server Runtime
      parameters:
      - $ref: '#/components/parameters/dataSourceName'
      responses:
        '200':
          description: JDBC data source runtime
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JDBCDataSourceRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /serverRuntime/JMSRuntime:
    get:
      operationId: getJMSRuntime
      summary: Oracle WebLogic Server APIs Get JMS runtime information
      description: Returns JMS runtime information including JMS server runtimes and connection statistics for the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: JMS runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JMSRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/JMSRuntime/JMSServers:
    get:
      operationId: getJMSServerRuntimes
      summary: Oracle WebLogic Server APIs List all JMS server runtimes
      description: Returns runtime information for all JMS servers on the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: List of JMS server runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/JMSServerRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/applicationRuntimes:
    get:
      operationId: getApplicationRuntimes
      summary: Oracle WebLogic Server APIs List all application runtimes
      description: Returns runtime information for all deployed applications on the current server.
      tags:
      - Server Runtime
      responses:
        '200':
          description: List of application runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApplicationRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /serverRuntime/applicationRuntimes/{appName}:
    get:
      operationId: getApplicationRuntime
      summary: Oracle WebLogic Server APIs Get an application runtime
      description: Returns runtime information for a specific deployed application.
      tags:
      - Server Runtime
      parameters:
      - $ref: '#/components/parameters/appName'
      responses:
        '200':
          description: Application runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    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
    JVMRuntime:
      type: object
      properties:
        name:
          type: string
        heapSizeCurrent:
          type: integer
          format: int64
          description: Current JVM heap size in bytes
        heapSizeMax:
          type: integer
          format: int64
          description: Maximum JVM heap size in bytes
        heapFreeCurrent:
          type: integer
          format: int64
          description: Current free heap memory in bytes
        heapFreePercent:
          type: number
          format: double
          description: Percentage of heap memory that is free
        javaVersion:
          type: string
          description: Java version
        javaVendor:
          type: string
          description: Java vendor name
        osName:
          type: string
          description: Operating system name
        osVersion:
          type: string
          description: Operating system version
        uptime:
          type: integer
          format: int64
          description: JVM uptime in milliseconds
    ApplicationRuntime:
      type: object
      properties:
        name:
          type: string
          description: Application name
        applicationName:
          type: string
          description: Deployment name of the application
        healthState:
          type: object
          properties:
            state:
              type: string
            subsystemName:
              type: string
        overallHealthState:
          type: object
          properties:
            state:
              type: string
            subsystemName:
              type: string
        activeVersionState:
          type: string
          description: Current version state of the application
        componentRuntimes:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              state:
                type: string
    JMSRuntime:
      type: object
      properties:
        name:
          type: string
        connectionsCurrentCount:
          type: integer
          description: Current number of JMS connections
        connectionsTotalCount:
          type: integer
          description: Total JMS connections created
        connectionsHighCount:
          type: integer
          description: High watermark of JMS connections
        JMSServersCurrentCount:
          type: integer
          description: Current number of JMS servers
        JMSServersTotalCount:
          type: integer
          description: Total JMS servers created
        JMSServersHighCount:
          type: integer
          description: High watermark of JMS servers
        healthState:
          type: object
          properties:
            state:
              type: string
            subsystemName:
              type: string
    JDBCServiceRuntime:
      type: object
      properties:
        name:
          type: string
        JDBCDataSourceRuntimeMBeans:
          type: array
          items:
            $ref: '#/components/schemas/JDBCDataSourceRuntime'
    JDBCDataSourceRuntime:
      type: object
      properties:
        name:
          type: string
          description: Data source name
        state:
          type: string
          description: Data source state
          enum:
          - Running
          - Suspended
          - Shutdown
          - Overloaded
          - Unknown
        enabled:
          type: boolean
          description: Whether the data source is enabled
        activeConnectionsCurrentCount:
          type: integer
          description: Current number of active connections
        activeConnectionsHighCount:
          type: integer
          description: High watermark of active connections
        activeConnectionsAverageCount:
          type: integer
          description: Average number of active connections
        connectionsTotalCount:
          type: integer
          description: Total connections created
        currCapacity:
          type: integer
          description: Current capacity of the connection pool
        numAvailable:
          type: integer
          description: Number of available connections
        numUnavailable:
          type: integer
          description: Number of unavailable connections
        highestNumAvailable:
          type: integer
          description: Highest number of available connections
        highestNumUnavailable:
          type: integer
          description: Highest number of unavailable connections
        waitingForConnectionCurrentCount:
          type: integer
          description: Current number of threads waiting for a connection
        waitingForConnectionHighCount:
          type: integer
          description: High watermark of threads waiting for a connection
        waitSecondsHighCount:
          type: integer
          description: Highest wait time in seconds
        connectionDelayTime:
          type: integer
          description: Average time to create a connection in milliseconds
        failuresToReconnectCount:
          type: integer
          description: Number of failures to reconnect
        leakedConnectionCount:
          type: integer
          description: Number of leaked connections
        prepStmtCacheCurrentSize:
          type: integer
          description: Current size of the prepared statement cache
    JMSServerRuntime:
      type: object
      properties:
        name:
          type: string
          description: JMS server name
        messagesCurrentCount:
          type: integer
          format: int64
          description: Current number of messages
        messagesPendingCount:
          type: integer
          format: int64
          description: Number of pending messages
        messagesHighCount:
          type: integer
          format: int64
          description: High watermark of messages
        messagesReceivedCount:
          type: integer
          format: int64
          description: Total messages received
        bytesCurrentCount:
          type: integer
          format: int64
          description: Current total bytes of all messages
        bytesPendingCount:
          type: integer
          format: int64
          description: Bytes of pending messages
        consumersCurrentCount:
          type: integer
          format: int64
          description: Current number of consumers
        consumersHighCount:
          type: integer
          format: int64
          description: High watermark of consumers
        destinationsCurrentCount:
          type: integer
          format: int64
          description: Current number of destinations
        sessionPoolsCurrentCount:
          type: integer
          format: int64
          description: Current number of session pools
        healthState:
          type: object
          properties:
            state:
              type: string
            subsystemName:
              type: string
    ServerRuntime:
      type: object
      properties:
        name:
          type: string
          description: Server name
        state:
          type: string
          description: Current server state
        listenAddress:
          type: string
          description: Current listen address
        listenPort:
          type: integer
          description: Current listen port
        SSLListenPort:
          type: integer
          description: Current SSL listen port
        activationTime:
          type: integer
          format: int64
          description: Server activation time in milliseconds since epoch
        currentMachine:
          type: string
          description: Machine the server is running on
        weblogicVersion:
          type: string
          description: WebLogic Server version string
        openSocketsCurrentCount:
          type: integer
          description: Current number of open sockets
        healthState:
          type: object
          properties:
            state:
              type: string
              enum:
              - HEALTH_OK
              - HEALTH_WARN
              - HEALTH_CRITICAL
              - HEALTH_FAILED
              - HEALTH_OVERLOADED
            subsystemName:
              type: string
            symptoms:
              type: array
              items:
                type: string
        restartRequired:
          type: boolean
          description: Whether a server restart is required
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    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
    ThreadPoolRuntime:
      type: object
      properties:
        name:
          type: string
        executeThreadTotalCount:
          type: integer
          description: Total number of execute threads
        executeThreadIdleCount:
          type: integer
          description: Number of idle execute threads
        hoggingThreadCount:
          type: integer
          description: Number of threads that are hogging resources
        stuckThreadCount:
          type: integer
          description: Number of stuck threads
        pendingUserRequestCount:
          type: integer
          description: Number of pending user requests in the queue
        throughput:
          type: number
          format: double
          description: Thread pool throughput
        completedRequestCount:
          type: integer
          format: int64
          description: Total number of completed requests
        overloadRejectedRequestsCount:
          type: integer
          format: int64
          description: Number of requests rejected due to overload
        queueLength:
          type: integer
          description: Current queue length
        sharedCapacityForWorkManagers:
          type: integer
          description: Shared capacity for work managers
        healthState:
          type: object
          properties:
            state:
              type: string
            subsystemName:
              type: string
  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:
    appName:
      name: appName
      in: path
      required: true
      description: The name of the deployed application
      schema:
        type: string
    dataSourceName:
      name: dataSourceName
      in: path
      required: true
      description: The name of the JDBC data source
      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