Oracle WebLogic Server Lifecycle 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: Server Lifecycle
  description: Server lifecycle operations (start, stop, suspend, resume)
paths:
  /domainRuntime/serverLifeCycleRuntimes:
    get:
      operationId: listServerLifeCycleRuntimes
      summary: Oracle WebLogic Server List all server lifecycle runtimes
      description: Returns lifecycle state for all servers in the domain including their current state (RUNNING, SHUTDOWN, STANDBY, etc.).
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Links'
      responses:
        '200':
          description: Collection of server lifecycle runtimes
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/ServerLifeCycleRuntime'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}:
    get:
      operationId: getServerLifeCycleRuntime
      summary: Oracle WebLogic Server Get lifecycle runtime for a specific server
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      responses:
        '200':
          description: Server lifecycle runtime
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerLifeCycleRuntime'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/start:
    post:
      operationId: startServer
      summary: Oracle WebLogic Server Start a managed server
      description: Starts the specified managed server. This is an asynchronous operation that returns a task for monitoring progress.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      - $ref: '#/components/parameters/Prefer'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Server started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
        '202':
          description: Start operation accepted and in progress
          headers:
            Location:
              description: URL to poll for task status
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/shutdown:
    post:
      operationId: shutdownServer
      summary: Oracle WebLogic Server Shut down a managed server
      description: Gracefully shuts down the specified managed server.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      - $ref: '#/components/parameters/Prefer'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                timeout:
                  type: integer
                  description: Timeout in seconds to wait for graceful shutdown
                ignoreSessions:
                  type: boolean
                  description: Whether to ignore active sessions during shutdown
                waitForAllSessions:
                  type: boolean
                  description: Whether to wait for all sessions to complete
      responses:
        '200':
          description: Server shut down successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
        '202':
          description: Shutdown operation accepted and in progress
          headers:
            Location:
              schema:
                type: string
                format: uri
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/forceShutdown:
    post:
      operationId: forceShutdownServer
      summary: Oracle WebLogic Server Force shut down a managed server
      description: Immediately shuts down the specified server without waiting for graceful completion.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Server force shutdown initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/suspend:
    post:
      operationId: suspendServer
      summary: Oracle WebLogic Server Suspend a managed server
      description: Suspends the specified server, placing it in admin mode.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                timeout:
                  type: integer
                ignoreSessions:
                  type: boolean
      responses:
        '200':
          description: Server suspended
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/resume:
    post:
      operationId: resumeServer
      summary: Oracle WebLogic Server Resume a suspended server
      description: Resumes a server that was previously suspended, returning it to running state.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Server resumed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskStatus'
  /domainRuntime/serverLifeCycleRuntimes/{serverName}/restartSSL:
    post:
      operationId: restartServerSSL
      summary: Oracle WebLogic Server Restart SSL on a server
      description: Restarts the SSL subsystem on the specified server.
      tags:
      - Server Lifecycle
      parameters:
      - $ref: '#/components/parameters/ServerName'
      - $ref: '#/components/parameters/XRequestedBy'
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: SSL restarted
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
    Prefer:
      name: Prefer
      in: header
      description: Controls async behavior. Use 'respond-async' for immediate return or 'wait=N' to wait N seconds.
      schema:
        type: string
        examples:
        - respond-async
        - wait=10
    XRequestedBy:
      name: X-Requested-By
      in: header
      required: true
      description: CSRF protection header required for POST and DELETE requests
      schema:
        type: string
        example: MyClient
    ServerName:
      name: serverName
      in: path
      required: true
      description: Name of the WebLogic Server instance
      schema:
        type: string
    Fields:
      name: fields
      in: query
      description: Comma-separated list of property names to include
      schema:
        type: string
  schemas:
    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'
    ServerLifeCycleRuntime:
      type: object
      properties:
        identity:
          type: array
          items:
            type: string
        name:
          type: string
          description: Server name
        state:
          type: string
          description: Current lifecycle state
          enum:
          - RUNNING
          - SHUTDOWN
          - STANDBY
          - ADMIN
          - FAILED
          - STARTING
          - SHUTTING_DOWN
          - SUSPENDING
          - FORCE_SHUTTING_DOWN
          - RESUMING
          - UNKNOWN
        type:
          type: string
          description: Runtime type identifier
          enum:
          - ServerLifeCycleRuntime
        nodeManagerRestartCount:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    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 with WebLogic Server credentials
externalDocs:
  description: WebLogic Server Monitoring Documentation
  url: https://docs.oracle.com/middleware/12213/wls/WLRUR/overview.htm