Oracle WebLogic Server Domain Runtime API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Deployment Application Deployment Domain Runtime 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: Domain Runtime
  description: Domain-wide runtime monitoring available from the admin server
paths:
  /domainRuntime:
    get:
      operationId: getDomainRuntime
      summary: Oracle WebLogic Server Get domain runtime information
      description: Returns the root of the domain runtime tree, providing access to domain-wide monitoring data including all server runtimes.
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Domain runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainRuntime'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /domainRuntime/serverRuntimes:
    get:
      operationId: listServerRuntimes
      summary: Oracle WebLogic Server List all server runtimes
      description: Returns runtime information for all running servers in the domain including state, health, and performance data.
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of server runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServerRuntime'
  /domainRuntime/serverRuntimes/{serverName}:
    get:
      operationId: getServerRuntimeByName
      summary: Oracle WebLogic Server Get runtime for a specific server
      description: Returns runtime information for the specified running server.
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Server runtime information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerRuntime'
        '404':
          $ref: '#/components/responses/NotFound'
  /domainRuntime/domainPartitionRuntimes:
    get:
      operationId: listPartitionRuntimes
      summary: Oracle WebLogic Server List partition runtimes
      description: Returns runtime status for all partitions in the domain.
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of partition runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/PartitionRuntime'
  /domainRuntime/domainPartitionRuntimes/{partitionName}:
    get:
      operationId: getPartitionRuntime
      summary: Oracle WebLogic Server Get runtime for a specific partition
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/PartitionName'
      responses:
        '200':
          description: Partition runtime
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionRuntime'
  /domainRuntime/domainPartitionRuntimes/{partitionName}/partitionLifeCycleRuntime:
    get:
      operationId: getPartitionLifeCycleRuntime
      summary: Oracle WebLogic Server Get partition lifecycle runtime
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/PartitionName'
      responses:
        '200':
          description: Partition lifecycle runtime
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartitionLifeCycleRuntime'
  /domainRuntime/domainPartitionRuntimes/{partitionName}/partitionLifeCycleRuntime/start:
    post:
      operationId: startPartition
      summary: Oracle WebLogic Server Start a partition
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/PartitionName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Partition started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
  /domainRuntime/domainPartitionRuntimes/{partitionName}/partitionLifeCycleRuntime/stop:
    post:
      operationId: stopPartition
      summary: Oracle WebLogic Server Stop a partition
      tags:
      - Domain Runtime
      parameters:
      - $ref: '#/components/parameters/PartitionName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Partition stopped
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
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
    ServerName:
      name: serverName
      in: path
      required: true
      description: Name of the WebLogic Server instance
      schema:
        type: string
    PartitionName:
      name: partitionName
      in: path
      required: true
      description: Name of the domain partition
      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
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include
      schema:
        type: string
  responses:
    NotFound:
      description: Requested resource does not exist
    Unauthorized:
      description: Authentication required or invalid credentials
  schemas:
    PartitionRuntime:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
        state:
          type: string
          enum:
          - RUNNING
          - SHUTDOWN
          - BOOTING
          - SHUTTING_DOWN
        restartRequired:
          type: boolean
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    TaskStatus:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        taskStatus:
          type: string
          description: Current status of the task
        progress:
          type: string
          description: Progress description
        description:
          type: string
          description: Human-readable task description
        operation:
          type: string
          description: Operation name
        running:
          type: boolean
          description: Whether the task is still running
        completed:
          type: boolean
          description: Whether the task has completed
        startTime:
          type: string
          format: date-time
          description: Time when the task started
        endTime:
          type: string
          format: date-time
          description: Time when the task completed
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    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'
    PartitionLifeCycleRuntime:
      type: object
      properties:
        state:
          type: string
          enum:
          - RUNNING
          - SHUTDOWN
          - BOOTING
          - SHUTTING_DOWN
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    DomainRuntime:
      type: object
      properties:
        name:
          type: string
          description: Domain name
        activationTime:
          type: integer
          format: int64
          description: Time when the domain was last activated
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    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
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
        title:
          type: string
  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