Oracle WebLogic Server Search API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Deployment Application Deployment Search 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: Search
  description: Query and search across configuration trees
paths:
  /edit/search:
    post:
      operationId: searchEditTree
      summary: Oracle WebLogic Server Search the edit configuration tree
      description: Performs a structured query against the edit configuration tree. Supports field filtering, child traversal, and collection filtering.
      tags:
      - Search
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchQuery'
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
  /domainConfig/search:
    post:
      operationId: searchDomainConfigTree
      summary: Oracle WebLogic Server Search the domain configuration tree
      tags:
      - Search
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchQuery'
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
  /serverConfig/search:
    post:
      operationId: searchServerConfigTree
      summary: Oracle WebLogic Server Search the server configuration tree
      tags:
      - Search
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchQuery'
      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:
    SearchQuery:
      type: object
      description: Structured query object for searching configuration and runtime trees. Supports field filtering, link filtering, child traversal, and collection item filtering.
      properties:
        fields:
          type: array
          items:
            type: string
          description: List of property names to include
        links:
          type: array
          items:
            type: string
          description: List of link relations to include
        children:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SearchQuery'
          description: Child collections to traverse
        names:
          type: array
          items:
            type: string
          description: Filter collection items by name
        mergeCollection:
          type: boolean
          description: Merge results from multiple servers
        mergeOn:
          type: string
          description: Property name to merge collection items on
  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