Oracle WebLogic Server Deployment Configuration API

Configure deployment targets and settings

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

oracle-weblogic-deployment-configuration-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Deployment Application Deployment Deployment Configuration 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: Deployment Configuration
  description: Configure deployment targets and settings
paths:
  /edit/appDeployments/{appName}/subDeployments:
    get:
      operationId: listAppSubDeployments
      summary: Oracle WebLogic Server List sub-deployments for an application
      tags:
      - Deployment Configuration
      parameters:
      - $ref: '#/components/parameters/AppName'
      responses:
        '200':
          description: Collection of sub-deployments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/SubDeployment'
    post:
      operationId: createAppSubDeployment
      summary: Oracle WebLogic Server Create a sub-deployment for an application
      tags:
      - Deployment Configuration
      parameters:
      - $ref: '#/components/parameters/AppName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubDeploymentCreateRequest'
      responses:
        '201':
          description: Sub-deployment created
components:
  parameters:
    AppName:
      name: appName
      in: path
      required: true
      description: Name of the application
      schema:
        type: string
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header
      schema:
        type: string
        example: MyClient
  schemas:
    SubDeployment:
      type: object
      properties:
        name:
          type: string
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
    Identity:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
    SubDeploymentCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
  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