Oracle WebLogic Server Runtime Search API

openapi: 3.2.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Monitoring and…
  description: RESTful API for accessing runtime monitoring data, diagnostics information, and performance metrics for Oracle WebLogic Server domains. Provides read-only access to the domainRuntime and serverRuntime bean trees for monitoring server states, application runtimes, JDBC data source health, JMS statistics, thread pool utilization, and server lifecycle management operations.
  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 Server (configurable)
  variables:
    host:
      default: localhost
    port:
      default: '7001'
    version:
      default: latest
security:
- basicAuth: []
tags:
- name: Runtime Search
  description: Structured queries against runtime trees
paths:
  /domainRuntime/search:
    post:
      operationId: searchDomainRuntime
      summary: Oracle WebLogic Server Search the domain runtime tree
      description: Performs a structured query against the domain runtime tree. Supports field filtering, child traversal, collection filtering, and result merging across servers.
      tags:
      - Runtime Search
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      - name: requestMaxWaitMillis
        in: query
        description: Maximum time in milliseconds to wait for search results
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeSearchQuery'
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
  /serverRuntime/search:
    post:
      operationId: searchServerRuntime
      summary: Oracle WebLogic Server Search the server runtime tree
      description: Performs a structured query against the current server's runtime tree.
      tags:
      - Runtime Search
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuntimeSearchQuery'
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
components:
  parameters:
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header required for POST and DELETE requests
      schema:
        type: string
        example: MyClient
  schemas:
    RuntimeSearchQuery:
      type: object
      description: Structured query for searching runtime trees. Supports field filtering, child traversal, collection filtering, and result merging for consolidated views across servers.
      properties:
        fields:
          type: array
          items:
            oneOf:
            - type: string
            - type: object
              properties:
                name:
                  type: string
                sameValue:
                  type: boolean
                total:
                  type: boolean
          description: Properties to include in results
        links:
          type: array
          items:
            type: string
        children:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RuntimeSearchQuery'
        name:
          type: array
          items:
            type: string
          description: Filter collection by specific names
        names:
          type: array
          items:
            type: string
          description: Filter collection by specific names
        mergeCollection:
          type: boolean
          description: Merge items from the same collection across servers
        mergeOn:
          type: string
          description: Property to merge collection items on
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with WebLogic Server credentials
externalDocs:
  description: WebLogic Server Monitoring Documentation
  url: https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm