Oracle WebLogic Server Runtime API

openapi: 3.2.0
info:
  title: Oracle Weblogic Server Runtime API
  version: '1.0'
  description: 'Operations tagged Server Runtime across 2 of this provider''s published API definitions: oracle-weblogic-monitoring-openapi.yml, weblogic-server-runtime-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:7001/management/weblogic/latest
  description: WebLogic Administration Server (default)
- url: http://{host}:{port}/management/weblogic/{version}
  description: WebLogic Server (configurable)
  variables:
    host:
      default: localhost
    port:
      default: '7001'
    version:
      default: latest
- 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: Individual server runtime monitoring
paths:
  /serverRuntime:
    get:
      operationId: getServerRuntime
      summary: Oracle WebLogic Server Get current server runtime
      description: Returns the runtime information for the server receiving this request. Available on both admin and managed servers.
      tags:
      - Server Runtime
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Current server runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerRuntime'
    servers:
    - url: http://localhost:7001/management/weblogic/latest
      description: WebLogic Administration Server (default)
    - url: http://{host}:{port}/management/weblogic/{version}
      description: WebLogic Server (configurable)
      variables:
        host:
          default: localhost
        port:
          default: '7001'
        version:
          default: latest
  /domainRuntime/serverRuntimes/{serverName}/getURL:
    post:
      operationId: getServerURL
      summary: Oracle WebLogic Server Get the URL for a server
      description: Returns the URL for accessing the specified server using the given protocol.
      tags:
      - Server Runtime
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                protocol:
                  type: string
                  description: Protocol to use (http, https, t3, t3s)
      responses:
        '200':
          description: Server URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  return:
                    type: string
                    format: uri
                    description: The server URL for the specified protocol
    servers:
    - url: http://localhost:7001/management/weblogic/latest
      description: WebLogic Administration Server (default)
    - url: http://{host}:{port}/management/weblogic/{version}
      description: WebLogic Server (configurable)
      variables:
        host:
          default: localhost
        port:
          default: '7001'
        version:
          default: latest
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
  /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'
    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
components:
  parameters:
    Links:
      name: links
      in: query
      description: Comma-separated list of link relations to include. Use 'none' to exclude all links.
      schema:
        type: string
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header required for POST and DELETE requests
      schema:
        type: string
        example: MyClient
    ServerName:
      name: serverName
      in: path
      required: true
      description: Name of the WebLogic Server instance
      schema:
        type: string
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include
      schema:
        type: string
    dataSourceName:
      name: dataSourceName
      in: path
      required: true
      description: The name of the JDBC data source
      schema:
        type: string
    appName:
      name: appName
      in: path
      required: true
      description: The name of the deployed application
      schema:
        type: string
  schemas:
    ServerRuntime:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Server name
        state:
          type: string
          description: Current server state
          enum:
          - RUNNING
          - STANDBY
          - ADMIN
          - SHUTDOWN
          - FAILED
          - STARTING
          - SHUTTING_DOWN
          - SUSPENDING
          - FORCE_SHUTTING_DOWN
          - RESUMING
        healthState:
          $ref: '#/components/schemas/HealthState'
        weblogicVersion:
          type: string
          description: WebLogic Server version
        openSocketsCurrentCount:
          type: integer
          description: Current number of open sockets
        activationTime:
          type: integer
          format: int64
          description: Time when the server was activated
        currentDirectory:
          type: string
          description: Current working directory
        adminServer:
          type: boolean
          description: Whether this server is the admin server
        adminServerHost:
          type: string
        adminServerListenPort:
          type: integer
        restartRequired:
          type: boolean
          description: Whether a restart is required for pending changes
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
        title:
          type: string
    HealthState:
      type: object
      properties:
        state:
          type: string
          enum:
          - HEALTH_OK
          - HEALTH_WARN
          - HEALTH_CRITICAL
          - HEALTH_FAILED
          - HEALTH_OVERLOADED
        subsystemName:
          type: string
        partitionName:
          type: string
        symptoms:
          type: array
          items:
            type: object
    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
    JDBCServiceRuntime:
      type: object
      properties:
        name:
          type: string
        JDBCDataSourceRuntimeMBeans:
          type: array
          items:
            $ref: '#/components/schemas/JDBCDataSourceRuntime'
    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
    ServerRuntime_2:
      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_2'
    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
    Link_2:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
          description: Link URI
        title:
          type: string
          description: Link title
    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
    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
    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
    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
  responses:
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with WebLogic Server credentials
x-refined-from:
- oracle-weblogic-monitoring-openapi.yml
- weblogic-server-runtime-api-openapi.yml