Oracle WebLogic Server Application Deployments API

openapi: 3.1.0
info:
  title: Oracle WebLogic Server Oracle WebLogic Deployment Application Deployment Application Deployments 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: Application Deployments
  description: Deploy, configure, and manage enterprise application deployments (EAR, WAR files)
paths:
  /edit/appDeployments:
    get:
      operationId: listAppDeployments
      summary: Oracle WebLogic Server List all application deployments
      description: Returns all application deployments configured in the domain including their targets and deployment settings.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of application deployments
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/AppDeployment'
                  links:
                    type: array
                    items:
                      $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: deployApplication
      summary: Oracle WebLogic Server Deploy an application
      description: Deploys a new application to the domain. The application source (EAR, WAR, or exploded directory) must be accessible from the admin server filesystem. Requires an active edit session.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/XRequestedBy'
      - $ref: '#/components/parameters/SaveChanges'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDeploymentCreateRequest'
            examples:
              deployToCluster:
                summary: Deploy to a cluster
                value:
                  name: MyApplication
                  targets:
                  - identity:
                    - clusters
                    - Cluster1
              deployToServer:
                summary: Deploy to a specific server
                value:
                  name: MyApplication
                  sourceURL: file:///path/to/myapp.ear
                  targets:
                  - identity:
                    - servers
                    - Server-0
      responses:
        '201':
          description: Application deployed successfully
          headers:
            Location:
              description: URL of the new application deployment resource
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    $ref: '#/components/schemas/AppDeployment'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /edit/appDeploymentCreateForm:
    get:
      operationId: getAppDeploymentCreateForm
      summary: Oracle WebLogic Server Get application deployment creation form
      description: Returns a pre-populated template with default values for deploying an application.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Deployment create form with defaults
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDeploymentCreateRequest'
  /edit/appDeployments/{appName}:
    get:
      operationId: getAppDeployment
      summary: Oracle WebLogic Server Get application deployment details
      description: Returns the deployment configuration for the specified application.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/AppName'
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Application deployment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDeployment'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: updateAppDeployment
      summary: Oracle WebLogic Server Update application deployment configuration
      description: Modifies the deployment configuration such as targets or deployment plan. Requires an active edit session.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/AppName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppDeploymentUpdateRequest'
      responses:
        '200':
          description: Deployment updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: array
                    items:
                      $ref: '#/components/schemas/Message'
    delete:
      operationId: undeployApplication
      summary: Oracle WebLogic Server Undeploy an application
      description: Removes the application deployment from the domain configuration. Requires an active edit session and must be followed by activation.
      tags:
      - Application Deployments
      parameters:
      - $ref: '#/components/parameters/AppName'
      - $ref: '#/components/parameters/XRequestedBy'
      responses:
        '204':
          description: Application undeployed
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Links:
      name: links
      in: query
      description: Comma-separated list of link relations to include
      schema:
        type: string
    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
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include
      schema:
        type: string
    SaveChanges:
      name: saveChanges
      in: query
      description: Whether to validate and save changes immediately
      schema:
        type: boolean
        default: true
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        wls:errorsDetails:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              title:
                type: string
              detail:
                type: string
              o:errorPath:
                type: string
    Identity:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
    AppDeploymentCreateRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Application name
        sourceURL:
          type: string
          description: URL or file path to the application archive (EAR, WAR) or exploded directory
        sourcePath:
          type: string
          description: Filesystem path to the application source
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
          description: Deployment targets (servers or clusters)
        planPath:
          type: string
          description: Path to deployment plan XML
        deploymentOrder:
          type: integer
          description: Deployment order priority
        stagingMode:
          type: string
          enum:
          - stage
          - nostage
          - external_stage
        securityDDModel:
          type: string
          enum:
          - DDOnly
          - CustomRoles
          - CustomRolesAndPolicies
          - Advanced
    AppDeploymentUpdateRequest:
      type: object
      properties:
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
        planPath:
          type: string
        deploymentOrder:
          type: integer
        stagingMode:
          type: string
          enum:
          - stage
          - nostage
          - external_stage
    Message:
      type: object
      properties:
        severity:
          type: string
          enum:
          - SUCCESS
          - WARNING
          - FAILURE
        field:
          type: string
        message:
          type: string
    AppDeployment:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Application deployment name
        sourcePath:
          type: string
          description: Path to the application source on the server
        targets:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
          description: Servers or clusters the application is targeted to
        deploymentOrder:
          type: integer
          description: Order in which applications are deployed during startup (lower numbers deploy first)
        planPath:
          type: string
          description: Path to the deployment plan XML file
        securityDDModel:
          type: string
          description: Security deployment descriptor model
          enum:
          - DDOnly
          - CustomRoles
          - CustomRolesAndPolicies
          - Advanced
        stagingMode:
          type: string
          description: How application files are made available to managed servers
          enum:
          - stage
          - nostage
          - external_stage
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
          format: uri
        title:
          type: string
  responses:
    NotFound:
      description: Application or resource not found
    BadRequest:
      description: Invalid request parameters or deployment source not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials
  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